001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.GetSalesOrderStatusChoicesForm;
020import com.echothree.control.user.sales.common.result.SalesResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.sales.server.logic.SalesOrderLogic;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import java.util.Arrays;
034import java.util.Collections;
035import java.util.List;
036
037public class GetSalesOrderStatusChoicesCommand
038        extends BaseSimpleCommand<GetSalesOrderStatusChoicesForm> {
039    
040    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
045                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
046                    new SecurityRoleDefinition(SecurityRoleGroups.SalesOrderStatus.name(), SecurityRoles.Choices.name())
047                    )))
048                )));
049
050        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
051                new FieldDefinition("OrderName", FieldType.ENTITY_NAME, false, null, null),
052                new FieldDefinition("DefaultSalesOrderStatusChoice", FieldType.ENTITY_NAME, false, null, null),
053                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
054                ));
055    }
056    
057    /** Creates a new instance of GetSalesOrderStatusChoicesCommand */
058    public GetSalesOrderStatusChoicesCommand(UserVisitPK userVisitPK, GetSalesOrderStatusChoicesForm form) {
059        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
060    }
061    
062    @Override
063    protected BaseResult execute() {
064        var result = SalesResultFactory.getGetSalesOrderStatusChoicesResult();
065        var orderName = form.getOrderName();
066        var order = orderName == null? null: SalesOrderLogic.getInstance().getOrderByName(this, orderName);
067
068        if(!hasExecutionErrors()) {
069            String defaultSalesOrderStatusChoice = form.getDefaultSalesOrderStatusChoice();
070            boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
071
072            result.setSalesOrderStatusChoices(SalesOrderLogic.getInstance().getSalesOrderStatusChoices(defaultSalesOrderStatusChoice,
073                    getPreferredLanguage(), allowNullChoice, order, getPartyPK()));
074        }
075
076        return result;
077    }
078    
079}