001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016
017package com.echothree.control.user.sales.server.command;
018
019import com.echothree.control.user.sales.common.form.SetSalesOrderStatusForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.sales.server.logic.SalesOrderLogic;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.common.validation.FieldType;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.server.control.BaseSimpleCommand;
029import com.echothree.util.server.control.CommandSecurityDefinition;
030import com.echothree.util.server.control.PartyTypeDefinition;
031import com.echothree.util.server.control.SecurityRoleDefinition;
032import java.util.List;
033import javax.enterprise.context.Dependent;
034
035@Dependent
036public class SetSalesOrderStatusCommand
037        extends BaseSimpleCommand<SetSalesOrderStatusForm> {
038    
039    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
040    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
041    
042    static {
043        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
044                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
045                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
046                    new SecurityRoleDefinition(SecurityRoleGroups.SalesOrderStatus.name(), SecurityRoles.Choices.name())
047                    ))
048                ));
049
050        FORM_FIELD_DEFINITIONS = List.of(
051                new FieldDefinition("OrderName", FieldType.ENTITY_NAME, true, null, null),
052                new FieldDefinition("SalesOrderStatusChoice", FieldType.ENTITY_NAME, true, null, null)
053                );
054    }
055    
056    /** Creates a new instance of SetSalesOrderStatusCommand */
057    public SetSalesOrderStatusCommand() {
058        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
059    }
060    
061    @Override
062    protected BaseResult execute() {
063        var order = SalesOrderLogic.getInstance().getOrderByName(this, form.getOrderName());
064
065        if(!hasExecutionErrors()) {
066            var salesOrderStatusChoice = form.getSalesOrderStatusChoice();
067
068            SalesOrderLogic.getInstance().setSalesOrderStatus(session, this, order, salesOrderStatusChoice, getPartyPK());
069        }
070        
071        return null;
072    }
073    
074}