001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.purchase.server.command;
018
019import com.echothree.control.user.purchase.common.form.GetPurchaseOrderStatusChoicesForm;
020import com.echothree.control.user.purchase.common.result.PurchaseResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.purchase.server.logic.PurchaseOrderLogic;
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;
036import javax.enterprise.context.RequestScoped;
037
038@RequestScoped
039public class GetPurchaseOrderStatusChoicesCommand
040        extends BaseSimpleCommand<GetPurchaseOrderStatusChoicesForm> {
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.PurchaseOrderStatus.name(), SecurityRoles.Choices.name())
049                    )))
050                )));
051        
052        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
053            new FieldDefinition("OrderName", FieldType.ENTITY_NAME, false, null, null),
054            new FieldDefinition("DefaultOrderStatusChoice", FieldType.ENTITY_NAME, false, null, null),
055            new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
056        ));
057    }
058    
059    /** Creates a new instance of GetPurchaseOrderStatusChoicesCommand */
060    public GetPurchaseOrderStatusChoicesCommand() {
061        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
062    }
063    
064    @Override
065    protected BaseResult execute() {
066        var purchaseOrderLogic = PurchaseOrderLogic.getInstance();
067        var result = PurchaseResultFactory.getGetPurchaseOrderStatusChoicesResult();
068        var orderName = form.getOrderName();
069        var order = purchaseOrderLogic.getOrderByName(this, orderName);
070        
071        if(!hasExecutionErrors()) {
072            var defaultOrderStatusChoice = form.getDefaultPurchaseOrderStatusChoice();
073            var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
074            
075            result.setPurchaseOrderStatusChoices(purchaseOrderLogic.getPurchaseOrderStatusChoices(defaultOrderStatusChoice, getPreferredLanguage(), allowNullChoice, order,
076                    getPartyPK()));
077        }
078        
079        return result;
080    }
081    
082}