001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.ItemUnitLimitEdit;
021import com.echothree.control.user.item.common.form.EditItemUnitLimitForm;
022import com.echothree.control.user.item.common.result.EditItemUnitLimitResult;
023import com.echothree.control.user.item.common.result.ItemResultFactory;
024import com.echothree.control.user.item.common.spec.ItemUnitLimitSpec;
025import com.echothree.model.control.inventory.server.control.InventoryControl;
026import com.echothree.model.control.item.server.control.ItemControl;
027import com.echothree.model.control.uom.server.control.UomControl;
028import com.echothree.model.data.inventory.server.entity.InventoryCondition;
029import com.echothree.model.data.item.server.entity.Item;
030import com.echothree.model.data.item.server.entity.ItemDetail;
031import com.echothree.model.data.item.server.entity.ItemUnitLimit;
032import com.echothree.model.data.item.server.value.ItemUnitLimitValue;
033import com.echothree.model.data.uom.server.entity.UnitOfMeasureType;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.EditMode;
039import com.echothree.util.server.control.BaseAbstractEditCommand;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class EditItemUnitLimitCommand
046        extends BaseAbstractEditCommand<ItemUnitLimitSpec, ItemUnitLimitEdit, EditItemUnitLimitResult, ItemUnitLimit, ItemUnitLimit> {
047    
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050    
051    static {
052        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
053                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
054                new FieldDefinition("InventoryConditionName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("UnitOfMeasureTypeName", FieldType.ENTITY_NAME, true, null, null)
056                ));
057        
058        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("MinimumQuantity", FieldType.UNSIGNED_LONG, false, null, null),
060                new FieldDefinition("MaximumQuantity", FieldType.UNSIGNED_LONG, false, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of EditItemUnitLimitCommand */
065    public EditItemUnitLimitCommand(UserVisitPK userVisitPK, EditItemUnitLimitForm form) {
066        super(userVisitPK, form, null, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
067    }
068    
069    @Override
070    public EditItemUnitLimitResult getResult() {
071        return ItemResultFactory.getEditItemUnitLimitResult();
072    }
073
074    @Override
075    public ItemUnitLimitEdit getEdit() {
076        return ItemEditFactory.getItemUnitLimitEdit();
077    }
078
079    @Override
080    public ItemUnitLimit getEntity(EditItemUnitLimitResult result) {
081        var itemControl = Session.getModelController(ItemControl.class);
082        ItemUnitLimit itemUnitLimit = null;
083        String itemName = spec.getItemName();
084        Item item = itemControl.getItemByName(itemName);
085
086        if(item != null) {
087            var inventoryControl = Session.getModelController(InventoryControl.class);
088            String inventoryConditionName = spec.getInventoryConditionName();
089            InventoryCondition inventoryCondition = inventoryControl.getInventoryConditionByName(inventoryConditionName);
090
091            if(inventoryCondition != null) {
092                var uomControl = Session.getModelController(UomControl.class);
093                ItemDetail itemDetail = item.getLastDetail();
094                String unitOfMeasureTypeName = spec.getUnitOfMeasureTypeName();
095                UnitOfMeasureType unitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(itemDetail.getUnitOfMeasureKind(), unitOfMeasureTypeName);
096
097                if(unitOfMeasureType != null) {
098                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
099                        itemUnitLimit = itemControl.getItemUnitLimit(item, inventoryCondition, unitOfMeasureType);
100                    } else { // EditMode.UPDATE
101                        itemUnitLimit = itemControl.getItemUnitLimitForUpdate(item, inventoryCondition, unitOfMeasureType);
102                    }
103
104                    if(itemUnitLimit == null) {
105                        addExecutionError(ExecutionErrors.UnknownItemUnitLimit.name(), itemName, inventoryConditionName, unitOfMeasureTypeName);
106                    }
107                } else {
108                    addExecutionError(ExecutionErrors.UnknownUnitOfMeasureTypeName.name(), unitOfMeasureTypeName);
109                }
110            } else {
111                addExecutionError(ExecutionErrors.UnknownInventoryConditionName.name(), inventoryConditionName);
112            }
113        } else {
114            addExecutionError(ExecutionErrors.UnknownItemName.name(), itemName);
115        }
116
117        return itemUnitLimit;
118    }
119
120    @Override
121    public ItemUnitLimit getLockEntity(ItemUnitLimit itemUnitLimit) {
122        return itemUnitLimit;
123    }
124
125    @Override
126    public void fillInResult(EditItemUnitLimitResult result, ItemUnitLimit itemUnitLimit) {
127        var itemControl = Session.getModelController(ItemControl.class);
128
129        result.setItemUnitLimit(itemControl.getItemUnitLimitTransfer(getUserVisit(), itemUnitLimit));
130    }
131
132    Long minimumQuantity;
133    Long maximumQuantity;
134
135    @Override
136    public void doLock(ItemUnitLimitEdit edit, ItemUnitLimit itemUnitLimit) {
137        minimumQuantity = itemUnitLimit.getMinimumQuantity();
138        maximumQuantity = itemUnitLimit.getMaximumQuantity();
139
140        edit.setMinimumQuantity(minimumQuantity == null ? null : minimumQuantity.toString());
141        edit.setMaximumQuantity(maximumQuantity == null ? null : maximumQuantity.toString());
142    }
143
144    @Override
145    public void canUpdate(ItemUnitLimit itemUnitLimit) {
146        String strMinimumQuantity = edit.getMinimumQuantity();
147        String strMaximumQuantity = edit.getMaximumQuantity();
148
149        minimumQuantity = strMinimumQuantity == null ? null : Long.valueOf(strMinimumQuantity);
150        maximumQuantity = strMaximumQuantity == null ? null : Long.valueOf(strMaximumQuantity);
151
152        if(minimumQuantity != null && maximumQuantity != null) {
153            if(maximumQuantity < minimumQuantity) {
154                addExecutionError(ExecutionErrors.MaximumQuantityLessThanMinimumQuantity.name());
155            }
156        }
157    }
158
159    @Override
160    public void doUpdate(ItemUnitLimit itemUnitLimit) {
161        var itemControl = Session.getModelController(ItemControl.class);
162        ItemUnitLimitValue itemUnitLimitValue = itemControl.getItemUnitLimitValue(itemUnitLimit);
163
164        itemUnitLimitValue.setMinimumQuantity(minimumQuantity);
165        itemUnitLimitValue.setMaximumQuantity(maximumQuantity);
166
167        itemControl.updateItemUnitLimitFromValue(itemUnitLimitValue, getPartyPK());
168    }
169    
170}