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.PartyInventoryLevelEdit;
021import com.echothree.control.user.inventory.common.result.EditPartyInventoryLevelResult;
022import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
023import com.echothree.control.user.inventory.common.spec.PartyInventoryLevelSpec;
024import com.echothree.control.user.inventory.server.command.common.PartyInventoryLevelUtil;
025import com.echothree.model.control.inventory.server.control.InventoryControl;
026import com.echothree.model.control.item.server.control.ItemControl;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.control.uom.server.control.UomControl;
031import com.echothree.model.control.uom.server.logic.UnitOfMeasureTypeLogic;
032import com.echothree.model.control.uom.server.util.Conversion;
033import com.echothree.model.data.inventory.server.entity.PartyInventoryLevel;
034import com.echothree.model.data.item.server.entity.Item;
035import com.echothree.model.data.uom.server.entity.UnitOfMeasureKind;
036import com.echothree.util.common.command.EditMode;
037import com.echothree.util.common.message.ExecutionErrors;
038import com.echothree.util.common.validation.FieldDefinition;
039import com.echothree.util.common.validation.FieldType;
040import com.echothree.util.server.control.BaseAbstractEditCommand;
041import com.echothree.util.server.control.CommandSecurityDefinition;
042import com.echothree.util.server.control.PartyTypeDefinition;
043import com.echothree.util.server.control.SecurityRoleDefinition;
044import java.util.List;
045import javax.enterprise.context.Dependent;
046import javax.inject.Inject;
047
048@Dependent
049public class EditPartyInventoryLevelCommand
050        extends BaseAbstractEditCommand<PartyInventoryLevelSpec, PartyInventoryLevelEdit, EditPartyInventoryLevelResult, PartyInventoryLevel, Item> {
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.PartyInventoryLevel.name(), SecurityRoles.Edit.name())
061                ))
062        ));
063
064        SPEC_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null),
066                new FieldDefinition("CompanyName", FieldType.ENTITY_NAME, false, null, null),
067                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, false, null, null),
068                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
069                new FieldDefinition("InventoryConditionName", FieldType.ENTITY_NAME, true, null, null)
070        );
071        
072        EDIT_FIELD_DEFINITIONS = List.of(
073                new FieldDefinition("MinimumInventoryUnitOfMeasureTypeName", FieldType.ENTITY_NAME, false, null, null),
074                new FieldDefinition("MinimumInventory", FieldType.UNSIGNED_LONG, false, null, null),
075                new FieldDefinition("MaximumInventoryUnitOfMeasureTypeName", FieldType.ENTITY_NAME, false, null, null),
076                new FieldDefinition("MaximumInventory", FieldType.UNSIGNED_LONG, false, null, null),
077                new FieldDefinition("ReorderQuantityUnitOfMeasureTypeName", FieldType.ENTITY_NAME, false, null, null),
078                new FieldDefinition("ReorderQuantity", FieldType.UNSIGNED_LONG, false, null, null)
079        );
080    }
081
082    @Inject
083    InventoryControl inventoryControl;
084
085    @Inject
086    ItemControl itemControl;
087
088    @Inject
089    UomControl uomControl;
090
091    @Inject
092    UnitOfMeasureTypeLogic unitOfMeasureTypeLogic;
093
094    @Inject
095    PartyInventoryLevelUtil partyInventoryLevelUtil;
096
097    /** Creates a new instance of EditPartyInventoryLevelCommand */
098    public EditPartyInventoryLevelCommand() {
099        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
100    }
101
102    @Override
103    public EditPartyInventoryLevelResult getResult() {
104        return InventoryResultFactory.getEditPartyInventoryLevelResult();
105    }
106
107    @Override
108    public PartyInventoryLevelEdit getEdit() {
109        return InventoryEditFactory.getPartyInventoryLevelEdit();
110    }
111
112    UnitOfMeasureKind unitOfMeasureKind;
113
114    @Override
115    public PartyInventoryLevel getEntity(EditPartyInventoryLevelResult result) {
116        PartyInventoryLevel partyInventoryLevel = null;
117        var party = partyInventoryLevelUtil.getParty(this, spec);
118
119        if(party != null) {
120            var itemName = spec.getItemName();
121            var item = itemControl.getItemByName(itemName);
122
123            if(item != null) {
124                var partyTypeName = partyInventoryLevelUtil.getPartyTypeName(party);
125
126                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.UPDATE)) {
127                    unitOfMeasureKind = item.getLastDetail().getUnitOfMeasureKind();
128                }
129
130                if(partyTypeName.equals(PartyTypes.COMPANY.name())) {
131                    if(!party.equals(item.getLastDetail().getCompanyParty())) {
132                        addExecutionError(ExecutionErrors.InvalidCompany.name());
133                    }
134                }
135
136                if(!hasExecutionErrors()) {
137                    var inventoryConditionName = spec.getInventoryConditionName();
138                    var inventoryCondition = inventoryControl.getInventoryConditionByName(inventoryConditionName);
139
140                    if(inventoryCondition != null) {
141                        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
142                            partyInventoryLevel = inventoryControl.getPartyInventoryLevel(party, item, inventoryCondition);
143                        } else { // EditMode.UPDATE
144                            partyInventoryLevel = inventoryControl.getPartyInventoryLevelForUpdate(party, item, inventoryCondition);
145                        }
146
147                        if(partyInventoryLevel == null) {
148                            addExecutionError(ExecutionErrors.UnknownPartyInventoryLevel.name(), party.getLastDetail().getPartyName(), itemName, inventoryConditionName);
149                        }
150                    } else {
151                        addExecutionError(ExecutionErrors.UnknownInventoryConditionName.name(), inventoryConditionName);
152                    }
153                }
154            } else {
155                addExecutionError(ExecutionErrors.UnknownItemName.name(), itemName);
156            }
157        }
158
159        return partyInventoryLevel;
160    }
161
162    @Override
163    public Item getLockEntity(PartyInventoryLevel partyInventoryLevel) {
164        return partyInventoryLevel.getItem();
165    }
166
167    @Override
168    public void fillInResult(EditPartyInventoryLevelResult result, PartyInventoryLevel partyInventoryLevel) {
169        result.setPartyInventoryLevel(inventoryControl.getPartyInventoryLevelTransfer(getUserVisit(), partyInventoryLevel));
170    }
171
172    @Override
173    public void doLock(PartyInventoryLevelEdit edit, PartyInventoryLevel partyInventoryLevel) {
174        minimumInventory = partyInventoryLevel.getMinimumInventory();
175        var minimumInventoryConversion = minimumInventory == null ? null : new Conversion(uomControl, unitOfMeasureKind, minimumInventory).convertToHighestUnitOfMeasureType();
176
177        maximumInventory = partyInventoryLevel.getMaximumInventory();
178        var maximumInventoryConversion = maximumInventory == null ? null : new Conversion(uomControl, unitOfMeasureKind, maximumInventory).convertToHighestUnitOfMeasureType();
179
180        reorderQuantity = partyInventoryLevel.getReorderQuantity();
181        var reorderQuantityConversion = reorderQuantity == null ? null : new Conversion(uomControl, unitOfMeasureKind, reorderQuantity).convertToHighestUnitOfMeasureType();
182
183        edit.setMinimumInventory(minimumInventoryConversion.getQuantity().toString());
184        edit.setMinimumInventoryUnitOfMeasureTypeName(minimumInventoryConversion.getUnitOfMeasureType().getLastDetail().getUnitOfMeasureTypeName());
185        edit.setMaximumInventory(maximumInventoryConversion.getQuantity().toString());
186        edit.setMaximumInventoryUnitOfMeasureTypeName(maximumInventoryConversion.getUnitOfMeasureType().getLastDetail().getUnitOfMeasureTypeName());
187        edit.setReorderQuantity(reorderQuantityConversion.getQuantity().toString());
188        edit.setReorderQuantityUnitOfMeasureTypeName(reorderQuantityConversion.getUnitOfMeasureType().getLastDetail().getUnitOfMeasureTypeName());
189    }
190
191    Long minimumInventory;
192    Long maximumInventory;
193    Long reorderQuantity;
194
195    @Override
196    public void canUpdate(PartyInventoryLevel partyInventoryLevel) {
197        minimumInventory = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, unitOfMeasureKind,
198                edit.getMinimumInventory(), edit.getMinimumInventoryUnitOfMeasureTypeName(),
199                null, ExecutionErrors.MissingRequiredMinimumInventory.name(), null, ExecutionErrors.MissingRequiredMinimumInventoryUnitOfMeasureTypeName.name(),
200                null, ExecutionErrors.UnknownMinimumInventoryUnitOfMeasureTypeName.name());
201
202        if(!hasExecutionErrors()) {
203            maximumInventory = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, unitOfMeasureKind,
204                    edit.getMaximumInventory(), edit.getMaximumInventoryUnitOfMeasureTypeName(),
205                    null, ExecutionErrors.MissingRequiredMaximumInventory.name(), null, ExecutionErrors.MissingRequiredMaximumInventoryUnitOfMeasureTypeName.name(),
206                    null, ExecutionErrors.UnknownMaximumInventoryUnitOfMeasureTypeName.name());
207
208            if(!hasExecutionErrors()) {
209                reorderQuantity = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, unitOfMeasureKind,
210                        edit.getReorderQuantity(), edit.getReorderQuantityUnitOfMeasureTypeName(),
211                        null, ExecutionErrors.MissingRequiredReorderQuantity.name(), null, ExecutionErrors.MissingRequiredReorderQuantityUnitOfMeasureTypeName.name(),
212                        null, ExecutionErrors.UnknownReorderQuantityUnitOfMeasureTypeName.name());
213            }
214        }
215    }
216
217    @Override
218    public void doUpdate(PartyInventoryLevel partyInventoryLevel) {
219        var partyInventoryLevelValue = inventoryControl.getPartyInventoryLevelValue(partyInventoryLevel);
220
221        partyInventoryLevelValue.setMinimumInventory(minimumInventory);
222        partyInventoryLevelValue.setMaximumInventory(maximumInventory);
223        partyInventoryLevelValue.setReorderQuantity(reorderQuantity);
224
225        inventoryControl.updatePartyInventoryLevelFromValue(partyInventoryLevelValue, getPartyPK());
226    }
227
228}