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.edit.InventoryEditFactory;
020import com.echothree.control.user.inventory.common.edit.InventoryDispositionAdjustmentDescriptionEdit;
021import com.echothree.control.user.inventory.common.form.EditInventoryDispositionAdjustmentDescriptionForm;
022import com.echothree.control.user.inventory.common.result.EditInventoryDispositionAdjustmentDescriptionResult;
023import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
024import com.echothree.control.user.inventory.common.spec.InventoryDispositionAdjustmentDescriptionSpec;
025import com.echothree.model.control.inventory.server.control.InventoryDispositionAdjustmentControl;
026import com.echothree.model.control.inventory.server.logic.InventoryDispositionAdjustmentLogic;
027import com.echothree.model.control.inventory.server.logic.InventoryTransactionTypeLogic;
028import com.echothree.model.control.party.common.PartyTypes;
029import com.echothree.model.control.party.server.logic.LanguageLogic;
030import com.echothree.model.control.security.common.SecurityRoleGroups;
031import com.echothree.model.control.security.common.SecurityRoles;
032import com.echothree.model.data.inventory.server.entity.InventoryDispositionAdjustment;
033import com.echothree.model.data.inventory.server.entity.InventoryDispositionAdjustmentDescription;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.command.EditMode;
036import com.echothree.util.common.message.ExecutionErrors;
037import com.echothree.util.common.validation.FieldDefinition;
038import com.echothree.util.common.validation.FieldType;
039import com.echothree.util.server.control.BaseAbstractEditCommand;
040import com.echothree.util.server.control.CommandSecurityDefinition;
041import com.echothree.util.server.control.PartyTypeDefinition;
042import com.echothree.util.server.control.SecurityRoleDefinition;
043import java.util.List;
044import javax.enterprise.context.Dependent;
045import javax.inject.Inject;
046
047@Dependent
048public class EditInventoryDispositionAdjustmentDescriptionCommand
049        extends BaseAbstractEditCommand<InventoryDispositionAdjustmentDescriptionSpec, InventoryDispositionAdjustmentDescriptionEdit,
050                EditInventoryDispositionAdjustmentDescriptionResult, InventoryDispositionAdjustmentDescription, InventoryDispositionAdjustment> {
051    
052    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
053    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
054    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
055    
056    static {
057        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
060                        new SecurityRoleDefinition(SecurityRoleGroups.InventoryDispositionAdjustment.name(), SecurityRoles.Description.name())
061                ))
062        ));
063        
064        SPEC_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("InventoryTransactionTypeName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("InventoryDispositionName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("InventoryDispositionAdjustmentName", FieldType.ENTITY_NAME, true, null, null),
068                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
069        );
070        
071        EDIT_FIELD_DEFINITIONS = List.of(
072                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
073        );
074    }
075
076    @Inject
077    InventoryDispositionAdjustmentControl inventoryDispositionAdjustmentControl;
078
079    @Inject
080    InventoryDispositionAdjustmentLogic inventoryDispositionAdjustmentLogic;
081
082    @Inject
083    InventoryTransactionTypeLogic inventoryTransactionTypeLogic;
084
085    @Inject
086    LanguageLogic languageLogic;
087
088    
089    /** Creates a new instance of EditInventoryDispositionAdjustmentDescriptionCommand */
090    public EditInventoryDispositionAdjustmentDescriptionCommand() {
091        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
092    }
093    
094    @Override
095    public EditInventoryDispositionAdjustmentDescriptionResult getResult() {
096        return InventoryResultFactory.getEditInventoryDispositionAdjustmentDescriptionResult();
097    }
098
099    @Override
100    public InventoryDispositionAdjustmentDescriptionEdit getEdit() {
101        return InventoryEditFactory.getInventoryDispositionAdjustmentDescriptionEdit();
102    }
103
104    @Override
105    public InventoryDispositionAdjustmentDescription getEntity(EditInventoryDispositionAdjustmentDescriptionResult result) {
106        InventoryDispositionAdjustmentDescription inventoryDispositionAdjustmentDescription = null;
107        var inventoryTransactionTypeName = spec.getInventoryTransactionTypeName();
108        inventoryTransactionTypeLogic.getInventoryTransactionTypeByName(this, inventoryTransactionTypeName);
109
110        if(!hasExecutionErrors()) {
111            var inventoryDispositionAdjustmentName = spec.getInventoryDispositionAdjustmentName();
112            var inventoryDispositionAdjustment = inventoryDispositionAdjustmentLogic.getInventoryDispositionAdjustmentByName(this,
113                    spec.getInventoryTransactionTypeName(), spec.getInventoryDispositionName(), inventoryDispositionAdjustmentName);
114
115            if(!hasExecutionErrors()) {
116                var languageIsoName = spec.getLanguageIsoName();
117                var language = languageLogic.getLanguageByName(this, languageIsoName);
118
119                if(!hasExecutionErrors()) {
120                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
121                        inventoryDispositionAdjustmentDescription = inventoryDispositionAdjustmentControl
122                                .getInventoryDispositionAdjustmentDescription(inventoryDispositionAdjustment, language);
123                    } else { // EditMode.UPDATE
124                        inventoryDispositionAdjustmentDescription = 
125                                inventoryDispositionAdjustmentControl.getInventoryDispositionAdjustmentDescriptionForUpdate(
126                                        inventoryDispositionAdjustment, language);
127                    }
128
129                    if(inventoryDispositionAdjustmentDescription == null) {
130                        addExecutionError(ExecutionErrors.UnknownInventoryDispositionAdjustmentDescription.name(), inventoryTransactionTypeName,
131                                inventoryDispositionAdjustmentName, languageIsoName);
132                    }
133                }
134            }
135        }
136
137        return inventoryDispositionAdjustmentDescription;
138    }
139
140    @Override
141    public InventoryDispositionAdjustment getLockEntity(InventoryDispositionAdjustmentDescription inventoryDispositionAdjustmentDescription) {
142        return inventoryDispositionAdjustmentDescription.getInventoryDispositionAdjustment();
143    }
144
145    @Override
146    public void fillInResult(EditInventoryDispositionAdjustmentDescriptionResult result,
147            InventoryDispositionAdjustmentDescription inventoryDispositionAdjustmentDescription) {
148        result.setInventoryDispositionAdjustmentDescription(
149                inventoryDispositionAdjustmentControl.getInventoryDispositionAdjustmentDescriptionTransfer(getUserVisit(),
150                        inventoryDispositionAdjustmentDescription));
151    }
152
153    @Override
154    public void doLock(InventoryDispositionAdjustmentDescriptionEdit edit,
155            InventoryDispositionAdjustmentDescription inventoryDispositionAdjustmentDescription) {
156        edit.setDescription(inventoryDispositionAdjustmentDescription.getDescription());
157    }
158
159    @Override
160    public void doUpdate(InventoryDispositionAdjustmentDescription inventoryDispositionAdjustmentDescription) {
161        var inventoryDispositionAdjustmentDescriptionValue = 
162                inventoryDispositionAdjustmentControl.getInventoryDispositionAdjustmentDescriptionValue(inventoryDispositionAdjustmentDescription);
163        
164        inventoryDispositionAdjustmentDescriptionValue.setDescription(edit.getDescription());
165
166        inventoryDispositionAdjustmentControl.updateInventoryDispositionAdjustmentDescriptionFromValue(inventoryDispositionAdjustmentDescriptionValue,
167                getPartyPK());
168    }
169    
170}