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.GetSalesOrderBatchStatusChoicesForm;
020import com.echothree.control.user.sales.common.result.GetSalesOrderBatchStatusChoicesResult;
021import com.echothree.control.user.sales.common.result.SalesResultFactory;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.sales.server.logic.SalesOrderBatchLogic;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.batch.server.entity.Batch;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.Arrays;
036import java.util.Collections;
037import java.util.List;
038
039public class GetSalesOrderBatchStatusChoicesCommand
040        extends BaseSimpleCommand<GetSalesOrderBatchStatusChoicesForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
048                    new SecurityRoleDefinition(SecurityRoleGroups.SalesOrderBatchStatus.name(), SecurityRoles.Choices.name())
049                    )))
050                )));
051
052        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
053                new FieldDefinition("BatchName", FieldType.ENTITY_NAME, false, null, null),
054                new FieldDefinition("DefaultSalesOrderBatchStatusChoice", FieldType.ENTITY_NAME, false, null, null),
055                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
056                ));
057    }
058    
059    /** Creates a new instance of GetSalesOrderBatchStatusChoicesCommand */
060    public GetSalesOrderBatchStatusChoicesCommand(UserVisitPK userVisitPK, GetSalesOrderBatchStatusChoicesForm form) {
061        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
062    }
063    
064    @Override
065    protected BaseResult execute() {
066        GetSalesOrderBatchStatusChoicesResult result = SalesResultFactory.getGetSalesOrderBatchStatusChoicesResult();
067        String batchName = form.getBatchName();
068        Batch batch = batchName == null? null: SalesOrderBatchLogic.getInstance().getBatchByName(this, batchName);
069
070        if(!hasExecutionErrors()) {
071            String defaultSalesOrderBatchStatusChoice = form.getDefaultSalesOrderBatchStatusChoice();
072            boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
073
074            result.setSalesOrderBatchStatusChoices(SalesOrderBatchLogic.getInstance().getSalesOrderBatchStatusChoices(defaultSalesOrderBatchStatusChoice,
075                    getPreferredLanguage(), allowNullChoice, batch, getPartyPK()));
076        }
077
078        return result;
079    }
080    
081}