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.InventoryDispositionDescriptionEdit;
021import com.echothree.control.user.inventory.common.form.EditInventoryDispositionDescriptionForm;
022import com.echothree.control.user.inventory.common.result.EditInventoryDispositionDescriptionResult;
023import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
024import com.echothree.control.user.inventory.common.spec.InventoryDispositionDescriptionSpec;
025import com.echothree.model.control.inventory.server.control.InventoryDispositionControl;
026import com.echothree.model.control.inventory.server.logic.InventoryDispositionLogic;
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.InventoryDisposition;
033import com.echothree.model.data.inventory.server.entity.InventoryDispositionDescription;
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 EditInventoryDispositionDescriptionCommand
049        extends BaseAbstractEditCommand<InventoryDispositionDescriptionSpec, InventoryDispositionDescriptionEdit,
050                EditInventoryDispositionDescriptionResult, InventoryDispositionDescription, InventoryDisposition> {
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.InventoryDisposition.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("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
068        );
069        
070        EDIT_FIELD_DEFINITIONS = List.of(
071                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
072        );
073    }
074
075    @Inject
076    InventoryDispositionControl inventoryDispositionControl;
077
078    @Inject
079    InventoryDispositionLogic inventoryDispositionLogic;
080
081    @Inject
082    InventoryTransactionTypeLogic inventoryTransactionTypeLogic;
083
084    @Inject
085    LanguageLogic languageLogic;
086
087    
088    /** Creates a new instance of EditInventoryDispositionDescriptionCommand */
089    public EditInventoryDispositionDescriptionCommand() {
090        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
091    }
092    
093    @Override
094    public EditInventoryDispositionDescriptionResult getResult() {
095        return InventoryResultFactory.getEditInventoryDispositionDescriptionResult();
096    }
097
098    @Override
099    public InventoryDispositionDescriptionEdit getEdit() {
100        return InventoryEditFactory.getInventoryDispositionDescriptionEdit();
101    }
102
103    @Override
104    public InventoryDispositionDescription getEntity(EditInventoryDispositionDescriptionResult result) {
105        InventoryDispositionDescription inventoryDispositionDescription = null;
106        var inventoryTransactionTypeName = spec.getInventoryTransactionTypeName();
107        var inventoryTransactionType = inventoryTransactionTypeLogic.getInventoryTransactionTypeByName(this, inventoryTransactionTypeName);
108
109        if(!hasExecutionErrors()) {
110            var inventoryDispositionName = spec.getInventoryDispositionName();
111            var inventoryDisposition = inventoryDispositionLogic.getInventoryDispositionByName(this,
112                    inventoryTransactionType, inventoryDispositionName);
113
114            if(!hasExecutionErrors()) {
115                var languageIsoName = spec.getLanguageIsoName();
116                var language = languageLogic.getLanguageByName(this, languageIsoName);
117
118                if(!hasExecutionErrors()) {
119                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
120                        inventoryDispositionDescription = 
121                                inventoryDispositionControl.getInventoryDispositionDescription(inventoryDisposition, language);
122                    } else { // EditMode.UPDATE
123                        inventoryDispositionDescription = 
124                                inventoryDispositionControl.getInventoryDispositionDescriptionForUpdate(
125                                        inventoryDisposition, language);
126                    }
127
128                    if(inventoryDispositionDescription == null) {
129                        addExecutionError(ExecutionErrors.UnknownInventoryDispositionDescription.name(), inventoryTransactionTypeName,
130                                inventoryDispositionName, languageIsoName);
131                    }
132                }
133            }
134        }
135
136        return inventoryDispositionDescription;
137    }
138
139    @Override
140    public InventoryDisposition getLockEntity(InventoryDispositionDescription inventoryDispositionDescription) {
141        return inventoryDispositionDescription.getInventoryDisposition();
142    }
143
144    @Override
145    public void fillInResult(EditInventoryDispositionDescriptionResult result,
146            InventoryDispositionDescription inventoryDispositionDescription) {
147        result.setInventoryDispositionDescription(
148                inventoryDispositionControl.getInventoryDispositionDescriptionTransfer(getUserVisit(),
149                        inventoryDispositionDescription));
150    }
151
152    @Override
153    public void doLock(InventoryDispositionDescriptionEdit edit,
154            InventoryDispositionDescription inventoryDispositionDescription) {
155        edit.setDescription(inventoryDispositionDescription.getDescription());
156    }
157
158    @Override
159    public void doUpdate(InventoryDispositionDescription inventoryDispositionDescription) {
160        var inventoryDispositionDescriptionValue = 
161                inventoryDispositionControl.getInventoryDispositionDescriptionValue(inventoryDispositionDescription);
162        
163        inventoryDispositionDescriptionValue.setDescription(edit.getDescription());
164
165        inventoryDispositionControl.updateInventoryDispositionDescriptionFromValue(inventoryDispositionDescriptionValue,
166                getPartyPK());
167    }
168    
169}