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.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.List;
034import javax.enterprise.context.Dependent;
035import javax.inject.Inject;
036
037@Dependent
038public class GetPurchaseOrderStatusChoicesCommand
039        extends BaseSimpleCommand<GetPurchaseOrderStatusChoicesForm> {
040    
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
046                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
047                        new SecurityRoleDefinition(SecurityRoleGroups.PurchaseOrderStatus.name(), SecurityRoles.Choices.name())
048                ))
049        ));
050        
051        FORM_FIELD_DEFINITIONS = List.of(
052                new FieldDefinition("OrderName", FieldType.ENTITY_NAME, false, null, null),
053                new FieldDefinition("DefaultOrderStatusChoice", FieldType.ENTITY_NAME, false, null, null),
054                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
055        );
056    }
057
058    @Inject
059    PurchaseOrderLogic purchaseOrderLogic;
060
061    
062    /** Creates a new instance of GetPurchaseOrderStatusChoicesCommand */
063    public GetPurchaseOrderStatusChoicesCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var result = PurchaseResultFactory.getGetPurchaseOrderStatusChoicesResult();
070        var orderName = form.getOrderName();
071        var order = purchaseOrderLogic.getOrderByName(this, orderName);
072        
073        if(!hasExecutionErrors()) {
074            var defaultOrderStatusChoice = form.getDefaultPurchaseOrderStatusChoice();
075            var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
076            
077            result.setPurchaseOrderStatusChoices(purchaseOrderLogic.getPurchaseOrderStatusChoices(defaultOrderStatusChoice, getPreferredLanguage(), allowNullChoice, order,
078                    getPartyPK()));
079        }
080        
081        return result;
082    }
083    
084}