001// -------------------------------------------------------------------------------- 002// Copyright 2002-2025 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 com.echothree.util.server.persistence.Session; 045import java.util.List; 046import javax.enterprise.context.RequestScoped; 047 048@RequestScoped 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 /** Creates a new instance of EditItemVolumeCommand */ 081 public EditItemVolumeCommand() { 082 super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS); 083 } 084 085 @Override 086 public EditItemVolumeResult getResult() { 087 return ItemResultFactory.getEditItemVolumeResult(); 088 } 089 090 @Override 091 public ItemVolumeEdit getEdit() { 092 return ItemEditFactory.getItemVolumeEdit(); 093 } 094 095 UnitOfMeasureKind volumeUnitOfMeasureKind; 096 097 @Override 098 public ItemVolume getEntity(EditItemVolumeResult result) { 099 var itemControl = Session.getModelController(ItemControl.class); 100 var uomControl = Session.getModelController(UomControl.class); 101 ItemVolume itemVolume = null; 102 var itemName = spec.getItemName(); 103 var item = itemControl.getItemByName(itemName); 104 105 if(item != null) { 106 var unitOfMeasureTypeName = spec.getUnitOfMeasureTypeName(); 107 var unitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(item.getLastDetail().getUnitOfMeasureKind(), unitOfMeasureTypeName); 108 109 if(unitOfMeasureType != null) { 110 var itemVolumeType = ItemVolumeTypeLogic.getInstance().getItemVolumeTypeByName(this, spec.getItemVolumeTypeName()); 111 112 if(!hasExecutionErrors()) { 113 if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) { 114 itemVolume = itemControl.getItemVolume(item, unitOfMeasureType, itemVolumeType); 115 } else { // EditMode.UPDATE 116 itemVolume = itemControl.getItemVolumeForUpdate(item, unitOfMeasureType, itemVolumeType); 117 } 118 119 if(itemVolume == null) { 120 addExecutionError(ExecutionErrors.UnknownItemVolume.name(), itemName, unitOfMeasureTypeName); 121 } 122 } 123 } else { 124 addExecutionError(ExecutionErrors.UnknownUnitOfMeasureTypeName.name(), unitOfMeasureTypeName); 125 } 126 } else { 127 addExecutionError(ExecutionErrors.UnknownItemName.name(), itemName); 128 } 129 130 if(!hasExecutionErrors() && (editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.UPDATE))) { 131 volumeUnitOfMeasureKind = uomControl.getUnitOfMeasureKindByUnitOfMeasureKindUseTypeUsingNames(UomConstants.UnitOfMeasureKindUseType_VOLUME); 132 133 if(volumeUnitOfMeasureKind == null) { 134 addExecutionError(ExecutionErrors.UnknownVolumeUnitOfMeasureKind.name()); 135 } 136 } 137 138 return itemVolume; 139 } 140 141 @Override 142 public Item getLockEntity(ItemVolume itemVolume) { 143 return itemVolume.getItem(); 144 } 145 146 @Override 147 public void fillInResult(EditItemVolumeResult result, ItemVolume itemVolume) { 148 var itemControl = Session.getModelController(ItemControl.class); 149 150 result.setItemVolume(itemControl.getItemVolumeTransfer(getUserVisit(), itemVolume)); 151 } 152 153 @Override 154 public void doLock(ItemVolumeEdit edit, ItemVolume itemVolume) { 155 var uomControl = Session.getModelController(UomControl.class); 156 157 height = itemVolume.getHeight(); 158 var heightConversion = height == null ? null : new Conversion(uomControl, volumeUnitOfMeasureKind, height).convertToHighestUnitOfMeasureType(); 159 160 width = itemVolume.getWidth(); 161 var widthConversion = width == null ? null : new Conversion(uomControl, volumeUnitOfMeasureKind, width).convertToHighestUnitOfMeasureType(); 162 163 depth = itemVolume.getDepth(); 164 var depthConversion = depth == null ? null : new Conversion(uomControl, volumeUnitOfMeasureKind, depth).convertToHighestUnitOfMeasureType(); 165 166 edit.setHeight(heightConversion.getQuantity().toString()); 167 edit.setHeightUnitOfMeasureTypeName(heightConversion.getUnitOfMeasureType().getLastDetail().getUnitOfMeasureTypeName()); 168 edit.setWidth(widthConversion.getQuantity().toString()); 169 edit.setWidthUnitOfMeasureTypeName(widthConversion.getUnitOfMeasureType().getLastDetail().getUnitOfMeasureTypeName()); 170 edit.setDepth(depthConversion.getQuantity().toString()); 171 edit.setDepthUnitOfMeasureTypeName(depthConversion.getUnitOfMeasureType().getLastDetail().getUnitOfMeasureTypeName()); 172 } 173 174 UnitOfMeasureType heightUnitOfMeasureType; 175 Long height; 176 UnitOfMeasureType widthUnitOfMeasureType; 177 Long width; 178 UnitOfMeasureType depthUnitOfMeasureType; 179 Long depth; 180 181 @Override 182 public void canUpdate(ItemVolume itemVolume) { 183 var uomControl = Session.getModelController(UomControl.class); 184 var heightUnitOfMeasureTypeName = edit.getHeightUnitOfMeasureTypeName(); 185 186 heightUnitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(volumeUnitOfMeasureKind, heightUnitOfMeasureTypeName); 187 188 if(heightUnitOfMeasureType != null) { 189 height = Long.valueOf(edit.getHeight()); 190 191 if(height > 0) { 192 var widthUnitOfMeasureTypeName = edit.getWidthUnitOfMeasureTypeName(); 193 194 widthUnitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(volumeUnitOfMeasureKind, widthUnitOfMeasureTypeName); 195 196 if(widthUnitOfMeasureType != null) { 197 width = Long.valueOf(edit.getWidth()); 198 199 if(width > 0) { 200 var depthUnitOfMeasureTypeName = edit.getDepthUnitOfMeasureTypeName(); 201 202 depthUnitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(volumeUnitOfMeasureKind, depthUnitOfMeasureTypeName); 203 204 if(depthUnitOfMeasureType != null) { 205 depth = Long.valueOf(edit.getDepth()); 206 207 if(depth < 1) { 208 addExecutionError(ExecutionErrors.InvalidDepth.name(), depth); 209 } 210 } else { 211 addExecutionError(ExecutionErrors.UnknownDepthUnitOfMeasureTypeName.name(), depthUnitOfMeasureTypeName); 212 } 213 } else { 214 addExecutionError(ExecutionErrors.InvalidWidth.name(), width); 215 } 216 } else { 217 addExecutionError(ExecutionErrors.UnknownWidthUnitOfMeasureTypeName.name(), widthUnitOfMeasureTypeName); 218 } 219 } else { 220 addExecutionError(ExecutionErrors.InvalidHeight.name(), height); 221 } 222 } else { 223 addExecutionError(ExecutionErrors.UnknownHeightUnitOfMeasureTypeName.name(), heightUnitOfMeasureTypeName); 224 } 225 } 226 227 @Override 228 public void doUpdate(ItemVolume itemVolume) { 229 var itemControl = Session.getModelController(ItemControl.class); 230 var uomControl = Session.getModelController(UomControl.class); 231 var itemVolumeValue = itemControl.getItemVolumeValue(itemVolume); 232 233 var heightConversion = new Conversion(uomControl, heightUnitOfMeasureType, height).convertToLowestUnitOfMeasureType(); 234 var widthConversion = new Conversion(uomControl, widthUnitOfMeasureType, width).convertToLowestUnitOfMeasureType(); 235 var depthConversion = new Conversion(uomControl, depthUnitOfMeasureType, depth).convertToLowestUnitOfMeasureType(); 236 237 itemVolumeValue.setHeight(heightConversion.getQuantity()); 238 itemVolumeValue.setWidth(widthConversion.getQuantity()); 239 itemVolumeValue.setDepth(depthConversion.getQuantity()); 240 241 itemControl.updateItemVolumeFromValue(itemVolumeValue, getPartyPK()); 242 } 243 244}