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.InventoryTransactionReasonEdit;
020import com.echothree.control.user.inventory.common.edit.InventoryEditFactory;
021import com.echothree.control.user.inventory.common.result.EditInventoryTransactionReasonResult;
022import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
023import com.echothree.control.user.inventory.common.spec.InventoryTransactionReasonUniversalSpec;
024import com.echothree.model.control.inventory.server.control.InventoryTransactionReasonControl;
025import com.echothree.model.control.inventory.server.control.InventoryTransactionTypeControl;
026import com.echothree.model.control.inventory.server.logic.InventoryTransactionReasonLogic;
027import com.echothree.model.control.inventory.server.logic.InventoryDispositionLogic;
028import com.echothree.model.control.party.common.PartyTypes;
029import com.echothree.model.control.security.common.SecurityRoleGroups;
030import com.echothree.model.control.security.common.SecurityRoles;
031import com.echothree.model.data.inventory.server.entity.InventoryTransactionReason;
032import com.echothree.model.data.inventory.server.entity.InventoryDisposition;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.server.control.BaseAbstractEditCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042import javax.inject.Inject;
043
044@Dependent
045public class EditInventoryTransactionReasonCommand
046        extends BaseAbstractEditCommand<InventoryTransactionReasonUniversalSpec, InventoryTransactionReasonEdit,
047                EditInventoryTransactionReasonResult, InventoryTransactionReason, InventoryTransactionReason> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
057                        new SecurityRoleDefinition(SecurityRoleGroups.InventoryTransactionReason.name(), SecurityRoles.Edit.name())
058                ))
059        ));
060        
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("InventoryTransactionTypeName", FieldType.ENTITY_NAME, false, null, null),
063                new FieldDefinition("InventoryTransactionReasonName", FieldType.ENTITY_NAME, false, null, null),
064                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
065                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
066        );
067        
068        EDIT_FIELD_DEFINITIONS = List.of(
069                new FieldDefinition("InventoryTransactionReasonName", FieldType.ENTITY_NAME, true, null, null),
070                new FieldDefinition("InventoryDispositionName", FieldType.ENTITY_NAME, true, null, null),
071                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
072                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
073                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
074        );
075    }
076
077    @Inject
078    InventoryTransactionReasonControl inventoryTransactionReasonControl;
079
080    @Inject
081    InventoryTransactionTypeControl inventoryTransactionTypeControl;
082
083    @Inject
084    InventoryTransactionReasonLogic inventoryTransactionReasonLogic;
085
086    @Inject
087    InventoryDispositionLogic inventoryDispositionLogic;
088
089    
090    /** Creates a new instance of EditInventoryTransactionReasonCommand */
091    public EditInventoryTransactionReasonCommand() {
092        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
093    }
094
095    @Override
096    public EditInventoryTransactionReasonResult getResult() {
097        return InventoryResultFactory.getEditInventoryTransactionReasonResult();
098    }
099
100    @Override
101    public InventoryTransactionReasonEdit getEdit() {
102        return InventoryEditFactory.getInventoryTransactionReasonEdit();
103    }
104
105    @Override
106    public InventoryTransactionReason getEntity(EditInventoryTransactionReasonResult result) {
107        return inventoryTransactionReasonLogic.getInventoryTransactionReasonByUniversalSpec(this, spec, false,
108                editModeToEntityPermission(editMode));
109    }
110
111    @Override
112    public InventoryTransactionReason getLockEntity(InventoryTransactionReason inventoryTransactionReason) {
113        return inventoryTransactionReason;
114    }
115
116    @Override
117    public void fillInResult(EditInventoryTransactionReasonResult result, InventoryTransactionReason inventoryTransactionReason) {
118        result.setInventoryTransactionReason(inventoryTransactionReasonControl.getInventoryTransactionReasonTransfer(getUserVisit(),
119                inventoryTransactionReason));
120    }
121
122    @Override
123    public void doLock(InventoryTransactionReasonEdit edit, InventoryTransactionReason inventoryTransactionReason) {
124        var inventoryTransactionReasonDescription = 
125                inventoryTransactionReasonControl.getInventoryTransactionReasonDescription(inventoryTransactionReason, getPreferredLanguage());
126        var inventoryTransactionReasonDetail = inventoryTransactionReason.getLastDetail();
127
128        edit.setInventoryTransactionReasonName(inventoryTransactionReasonDetail.getInventoryTransactionReasonName());
129        edit.setInventoryDispositionName(inventoryTransactionReasonDetail.getInventoryDisposition().getLastDetail().getInventoryDispositionName());
130        edit.setIsDefault(inventoryTransactionReasonDetail.getIsDefault().toString());
131        edit.setSortOrder(inventoryTransactionReasonDetail.getSortOrder().toString());
132
133        if(inventoryTransactionReasonDescription != null) {
134            edit.setDescription(inventoryTransactionReasonDescription.getDescription());
135        }
136    }
137
138    InventoryDisposition inventoryDisposition;
139
140    @Override
141    public void canUpdate(InventoryTransactionReason inventoryTransactionReason) {
142        var inventoryTransactionType = inventoryTransactionReason.getLastDetail().getInventoryTransactionType();
143        var inventoryTransactionReasonName = edit.getInventoryTransactionReasonName();
144        var duplicateInventoryTransactionReason =
145                inventoryTransactionReasonControl.getInventoryTransactionReasonByName(inventoryTransactionType, inventoryTransactionReasonName);
146
147        if(duplicateInventoryTransactionReason != null && !inventoryTransactionReason.equals(duplicateInventoryTransactionReason)) {
148            addExecutionError(ExecutionErrors.DuplicateInventoryTransactionReasonName.name(),
149                    inventoryTransactionType.getLastDetail().getInventoryTransactionTypeName(),
150                    inventoryTransactionReasonName);
151        }
152
153        inventoryDisposition = inventoryDispositionLogic.getInventoryDispositionByName(this, inventoryTransactionType,
154                edit.getInventoryDispositionName());
155    }
156
157    @Override
158    public void doUpdate(InventoryTransactionReason inventoryTransactionReason) {
159        var partyPK = getPartyPK();
160        var inventoryTransactionReasonDetailValue = 
161                inventoryTransactionReasonControl.getInventoryTransactionReasonDetailValueForUpdate(inventoryTransactionReason);
162        var inventoryTransactionReasonDescription = 
163                inventoryTransactionReasonControl.getInventoryTransactionReasonDescriptionForUpdate(
164                        inventoryTransactionReason, getPreferredLanguage());
165        var description = edit.getDescription();
166
167        inventoryTransactionReasonDetailValue.setInventoryTransactionReasonName(edit.getInventoryTransactionReasonName());
168        inventoryTransactionReasonDetailValue.setInventoryDispositionPK(inventoryDisposition.getPrimaryKey());
169        inventoryTransactionReasonDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
170        inventoryTransactionReasonDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
171
172        inventoryTransactionReasonControl.updateInventoryTransactionReasonFromValue(inventoryTransactionReasonDetailValue, partyPK);
173
174        if(inventoryTransactionReasonDescription == null && description != null) {
175            inventoryTransactionReasonControl.createInventoryTransactionReasonDescription(inventoryTransactionReason, getPreferredLanguage(),
176                    description, partyPK);
177        } else {
178            if(inventoryTransactionReasonDescription != null && description == null) {
179                inventoryTransactionReasonControl.deleteInventoryTransactionReasonDescription(inventoryTransactionReasonDescription, partyPK);
180            } else {
181                if(inventoryTransactionReasonDescription != null && description != null) {
182                    var inventoryTransactionReasonDescriptionValue = 
183                            inventoryTransactionReasonControl.getInventoryTransactionReasonDescriptionValue(inventoryTransactionReasonDescription);
184
185                    inventoryTransactionReasonDescriptionValue.setDescription(description);
186                    inventoryTransactionReasonControl.updateInventoryTransactionReasonDescriptionFromValue(
187                            inventoryTransactionReasonDescriptionValue, partyPK);
188                }
189            }
190        }
191    }
192
193}