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.inventory.server.command;
018
019import com.echothree.control.user.inventory.common.form.GetInventoryTransactionReasonChoicesForm;
020import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
021import com.echothree.model.control.inventory.server.control.InventoryTransactionReasonControl;
022import com.echothree.model.control.inventory.server.logic.InventoryTransactionReasonLogic;
023import com.echothree.model.control.inventory.server.logic.InventoryTransactionTypeLogic;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetInventoryTransactionReasonChoicesCommand
042        extends BaseSimpleCommand<GetInventoryTransactionReasonChoicesForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.InventoryTransactionReason.name(), SecurityRoles.Choices.name())
051                ))
052        ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("InventoryTransactionTypeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("DefaultInventoryTransactionReasonChoice", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
058        );
059    }
060
061    @Inject
062    InventoryTransactionReasonControl inventoryTransactionReasonControl;
063
064    @Inject
065    InventoryTransactionTypeLogic inventoryTransactionTypeLogic;
066
067    /** Creates a new instance of GetInventoryTransactionReasonChoicesCommand */
068    public GetInventoryTransactionReasonChoicesCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        var result = InventoryResultFactory.getGetInventoryTransactionReasonChoicesResult();
075        var inventoryTransactionTypeName = form.getInventoryTransactionTypeName();
076        var inventoryTransactionType = inventoryTransactionTypeLogic.getInventoryTransactionTypeByName(this, inventoryTransactionTypeName);
077
078        if(!hasExecutionErrors()) {
079            var defaultInventoryTransactionReasonChoice = form.getDefaultInventoryTransactionReasonChoice();
080            var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
081
082            result.setInventoryTransactionReasonChoices(
083                    inventoryTransactionReasonControl.getInventoryTransactionReasonChoices(
084                            defaultInventoryTransactionReasonChoice, getPreferredLanguage(), allowNullChoice,
085                    inventoryTransactionType));
086        }
087
088        return result;
089    }
090    
091}