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.item.server.command;
018
019import com.echothree.control.user.item.common.edit.ItemEditFactory;
020import com.echothree.control.user.item.common.edit.ItemVolumeEdit;
021import com.echothree.control.user.item.common.result.EditItemVolumeResult;
022import com.echothree.control.user.item.common.result.ItemResultFactory;
023import com.echothree.control.user.item.common.spec.ItemVolumeSpec;
024import com.echothree.model.control.item.server.control.ItemControl;
025import com.echothree.model.control.item.server.logic.ItemVolumeTypeLogic;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.control.uom.common.UomConstants;
030import com.echothree.model.control.uom.server.control.UomControl;
031import com.echothree.model.control.uom.server.util.Conversion;
032import com.echothree.model.data.item.server.entity.Item;
033import com.echothree.model.data.item.server.entity.ItemVolume;
034import com.echothree.model.data.uom.server.entity.UnitOfMeasureKind;
035import com.echothree.model.data.uom.server.entity.UnitOfMeasureType;
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 EditItemVolumeCommand
050        extends BaseAbstractEditCommand<ItemVolumeSpec, ItemVolumeEdit, EditItemVolumeResult, ItemVolume, 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.ItemVolume.name(), SecurityRoles.Edit.name())
061                ))
062        ));
063
064        SPEC_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("UnitOfMeasureTypeName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("ItemVolumeTypeName", FieldType.ENTITY_NAME, true, null, null)
068        );
069        
070        EDIT_FIELD_DEFINITIONS = List.of(
071                new FieldDefinition("HeightUnitOfMeasureTypeName", FieldType.ENTITY_NAME, true, null, null),
072                new FieldDefinition("Height", FieldType.UNSIGNED_LONG, true, null, null),
073                new FieldDefinition("WidthUnitOfMeasureTypeName", FieldType.ENTITY_NAME, true, null, null),
074                new FieldDefinition("Width", FieldType.UNSIGNED_LONG, true, null, null),
075                new FieldDefinition("DepthUnitOfMeasureTypeName", FieldType.ENTITY_NAME, true, null, null),
076                new FieldDefinition("Depth", FieldType.UNSIGNED_LONG, true, null, null)
077        );
078    }
079
080    @Inject
081    ItemControl itemControl;
082
083    @Inject
084    UomControl uomControl;
085
086    @Inject
087    ItemVolumeTypeLogic itemVolumeTypeLogic;
088
089    
090    /** Creates a new instance of EditItemVolumeCommand */
091    public EditItemVolumeCommand() {
092        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
093    }
094    
095    @Override
096    public EditItemVolumeResult getResult() {
097        return ItemResultFactory.getEditItemVolumeResult();
098    }
099
100    @Override
101    public ItemVolumeEdit getEdit() {
102        return ItemEditFactory.getItemVolumeEdit();
103    }
104
105    UnitOfMeasureKind volumeUnitOfMeasureKind;
106
107    @Override
108    public ItemVolume getEntity(EditItemVolumeResult result) {
109        ItemVolume itemVolume = null;
110        var itemName = spec.getItemName();
111        var item = itemControl.getItemByName(itemName);
112
113        if(item != null) {
114            var unitOfMeasureTypeName = spec.getUnitOfMeasureTypeName();
115            var unitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(item.getLastDetail().getUnitOfMeasureKind(), unitOfMeasureTypeName);
116
117            if(unitOfMeasureType != null) {
118                var itemVolumeType = itemVolumeTypeLogic.getItemVolumeTypeByName(this, spec.getItemVolumeTypeName());
119
120                if(!hasExecutionErrors()) {
121                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
122                        itemVolume = itemControl.getItemVolume(item, unitOfMeasureType, itemVolumeType);
123                    } else { // EditMode.UPDATE
124                        itemVolume = itemControl.getItemVolumeForUpdate(item, unitOfMeasureType, itemVolumeType);
125                    }
126    
127                    if(itemVolume == null) {
128                        addExecutionError(ExecutionErrors.UnknownItemVolume.name(), itemName, unitOfMeasureTypeName);
129                    }
130                }
131            } else {
132                addExecutionError(ExecutionErrors.UnknownUnitOfMeasureTypeName.name(), unitOfMeasureTypeName);
133            }
134        } else {
135            addExecutionError(ExecutionErrors.UnknownItemName.name(), itemName);
136        }
137
138        if(!hasExecutionErrors() && (editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.UPDATE))) {
139            volumeUnitOfMeasureKind = uomControl.getUnitOfMeasureKindByUnitOfMeasureKindUseTypeUsingNames(UomConstants.UnitOfMeasureKindUseType_VOLUME);
140
141            if(volumeUnitOfMeasureKind == null) {
142                addExecutionError(ExecutionErrors.UnknownVolumeUnitOfMeasureKind.name());
143            }
144        }
145
146        return itemVolume;
147    }
148
149    @Override
150    public Item getLockEntity(ItemVolume itemVolume) {
151        return itemVolume.getItem();
152    }
153
154    @Override
155    public void fillInResult(EditItemVolumeResult result, ItemVolume itemVolume) {
156        result.setItemVolume(itemControl.getItemVolumeTransfer(getUserVisit(), itemVolume));
157    }
158
159    @Override
160    public void doLock(ItemVolumeEdit edit, ItemVolume itemVolume) {
161        height = itemVolume.getHeight();
162        var heightConversion = height == null ? null : new Conversion(uomControl, volumeUnitOfMeasureKind, height).convertToHighestUnitOfMeasureType();
163
164        width = itemVolume.getWidth();
165        var widthConversion = width == null ? null : new Conversion(uomControl, volumeUnitOfMeasureKind, width).convertToHighestUnitOfMeasureType();
166
167        depth = itemVolume.getDepth();
168        var depthConversion = depth == null ? null : new Conversion(uomControl, volumeUnitOfMeasureKind, depth).convertToHighestUnitOfMeasureType();
169
170        edit.setHeight(heightConversion.getQuantity().toString());
171        edit.setHeightUnitOfMeasureTypeName(heightConversion.getUnitOfMeasureType().getLastDetail().getUnitOfMeasureTypeName());
172        edit.setWidth(widthConversion.getQuantity().toString());
173        edit.setWidthUnitOfMeasureTypeName(widthConversion.getUnitOfMeasureType().getLastDetail().getUnitOfMeasureTypeName());
174        edit.setDepth(depthConversion.getQuantity().toString());
175        edit.setDepthUnitOfMeasureTypeName(depthConversion.getUnitOfMeasureType().getLastDetail().getUnitOfMeasureTypeName());
176    }
177
178    UnitOfMeasureType heightUnitOfMeasureType;
179    Long height;
180    UnitOfMeasureType widthUnitOfMeasureType;
181    Long width;
182    UnitOfMeasureType depthUnitOfMeasureType;
183    Long depth;
184
185    @Override
186    public void canUpdate(ItemVolume itemVolume) {
187        var heightUnitOfMeasureTypeName = edit.getHeightUnitOfMeasureTypeName();
188
189        heightUnitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(volumeUnitOfMeasureKind, heightUnitOfMeasureTypeName);
190
191        if(heightUnitOfMeasureType != null) {
192            height = Long.valueOf(edit.getHeight());
193
194            if(height > 0) {
195                var widthUnitOfMeasureTypeName = edit.getWidthUnitOfMeasureTypeName();
196
197                widthUnitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(volumeUnitOfMeasureKind, widthUnitOfMeasureTypeName);
198
199                if(widthUnitOfMeasureType != null) {
200                    width = Long.valueOf(edit.getWidth());
201
202                    if(width > 0) {
203                        var depthUnitOfMeasureTypeName = edit.getDepthUnitOfMeasureTypeName();
204
205                        depthUnitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(volumeUnitOfMeasureKind, depthUnitOfMeasureTypeName);
206
207                        if(depthUnitOfMeasureType != null) {
208                            depth = Long.valueOf(edit.getDepth());
209
210                            if(depth < 1) {
211                                addExecutionError(ExecutionErrors.InvalidDepth.name(), depth);
212                            }
213                        } else {
214                            addExecutionError(ExecutionErrors.UnknownDepthUnitOfMeasureTypeName.name(), depthUnitOfMeasureTypeName);
215                        }
216                    } else {
217                        addExecutionError(ExecutionErrors.InvalidWidth.name(), width);
218                    }
219                } else {
220                    addExecutionError(ExecutionErrors.UnknownWidthUnitOfMeasureTypeName.name(), widthUnitOfMeasureTypeName);
221                }
222            } else {
223                addExecutionError(ExecutionErrors.InvalidHeight.name(), height);
224            }
225        } else {
226            addExecutionError(ExecutionErrors.UnknownHeightUnitOfMeasureTypeName.name(), heightUnitOfMeasureTypeName);
227        }
228    }
229
230    @Override
231    public void doUpdate(ItemVolume itemVolume) {
232        var itemVolumeValue = itemControl.getItemVolumeValue(itemVolume);
233
234        var heightConversion = new Conversion(uomControl, heightUnitOfMeasureType, height).convertToLowestUnitOfMeasureType();
235        var widthConversion = new Conversion(uomControl, widthUnitOfMeasureType, width).convertToLowestUnitOfMeasureType();
236        var depthConversion = new Conversion(uomControl, depthUnitOfMeasureType, depth).convertToLowestUnitOfMeasureType();
237
238        itemVolumeValue.setHeight(heightConversion.getQuantity());
239        itemVolumeValue.setWidth(widthConversion.getQuantity());
240        itemVolumeValue.setDepth(depthConversion.getQuantity());
241
242        itemControl.updateItemVolumeFromValue(itemVolumeValue, getPartyPK());
243    }
244    
245}