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.GetInventoryDispositionAdjustmentDescriptionForm;
020import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
021import com.echothree.model.control.inventory.server.control.InventoryDispositionAdjustmentControl;
022import com.echothree.model.control.inventory.server.logic.InventoryDispositionAdjustmentLogic;
023import com.echothree.model.control.inventory.server.logic.InventoryTransactionTypeLogic;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.party.server.logic.LanguageLogic;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.data.inventory.server.entity.InventoryDispositionAdjustmentDescription;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseSingleEntityCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetInventoryDispositionAdjustmentDescriptionCommand
043        extends BaseSingleEntityCommand<InventoryDispositionAdjustmentDescription, GetInventoryDispositionAdjustmentDescriptionForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.InventoryDispositionAdjustment.name(), SecurityRoles.Description.name())
053                ))
054        ));
055        
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("InventoryTransactionTypeName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("InventoryDispositionName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("InventoryDispositionAdjustmentName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
061        );
062    }
063
064    @Inject
065    InventoryDispositionAdjustmentControl inventoryDispositionAdjustmentControl;
066
067    @Inject
068    InventoryDispositionAdjustmentLogic inventoryDispositionAdjustmentLogic;
069
070    @Inject
071    InventoryTransactionTypeLogic inventoryTransactionTypeLogic;
072
073    @Inject
074    LanguageLogic languageLogic;
075
076    /** Creates a new instance of GetInventoryDispositionAdjustmentDescriptionCommand */
077    public GetInventoryDispositionAdjustmentDescriptionCommand() {
078        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
079    }
080    
081    @Override
082    protected InventoryDispositionAdjustmentDescription getEntity() {
083        InventoryDispositionAdjustmentDescription inventoryDispositionAdjustmentDescription = null;
084        var inventoryTransactionTypeName = form.getInventoryTransactionTypeName();
085        inventoryTransactionTypeLogic.getInventoryTransactionTypeByName(this, inventoryTransactionTypeName);
086
087        if(!hasExecutionErrors()) {
088            var inventoryDispositionAdjustmentName = form.getInventoryDispositionAdjustmentName();
089            var inventoryDispositionAdjustment = inventoryDispositionAdjustmentLogic.getInventoryDispositionAdjustmentByName(this,
090                    form.getInventoryTransactionTypeName(), form.getInventoryDispositionName(), inventoryDispositionAdjustmentName);
091
092            if(!hasExecutionErrors()) {
093                var languageIsoName = form.getLanguageIsoName();
094                var language = languageLogic.getLanguageByName(this, languageIsoName);
095
096                if(!hasExecutionErrors()) {
097                    inventoryDispositionAdjustmentDescription = inventoryDispositionAdjustmentControl.getInventoryDispositionAdjustmentDescription(
098                            inventoryDispositionAdjustment, language);
099
100                    if(inventoryDispositionAdjustmentDescription == null) {
101                        addExecutionError(ExecutionErrors.UnknownInventoryDispositionAdjustmentDescription.name(), inventoryTransactionTypeName,
102                                inventoryDispositionAdjustmentName, languageIsoName);
103                    }
104                }
105            }
106        }
107
108        return inventoryDispositionAdjustmentDescription;
109    }
110
111    @Override
112    protected BaseResult getResult(InventoryDispositionAdjustmentDescription inventoryDispositionAdjustmentDescription) {
113        var result = InventoryResultFactory.getGetInventoryDispositionAdjustmentDescriptionResult();
114
115        if(inventoryDispositionAdjustmentDescription != null) {
116            result.setInventoryDispositionAdjustmentDescription(
117                    inventoryDispositionAdjustmentControl.getInventoryDispositionAdjustmentDescriptionTransfer(getUserVisit(),
118                            inventoryDispositionAdjustmentDescription));
119        }
120
121        return result;
122    }
123    
124}