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.ItemUnitPriceLimitEdit;
021import com.echothree.control.user.item.common.form.EditItemUnitPriceLimitForm;
022import com.echothree.control.user.item.common.result.EditItemUnitPriceLimitResult;
023import com.echothree.control.user.item.common.result.ItemResultFactory;
024import com.echothree.control.user.item.common.spec.ItemUnitPriceLimitSpec;
025import com.echothree.model.control.accounting.server.control.AccountingControl;
026import com.echothree.model.control.inventory.server.control.InventoryControl;
027import com.echothree.model.control.item.server.control.ItemControl;
028import com.echothree.model.control.uom.server.control.UomControl;
029import com.echothree.model.data.accounting.server.entity.Currency;
030import com.echothree.model.data.inventory.server.entity.InventoryCondition;
031import com.echothree.model.data.item.server.entity.Item;
032import com.echothree.model.data.item.server.entity.ItemDetail;
033import com.echothree.model.data.item.server.entity.ItemUnitPriceLimit;
034import com.echothree.model.data.item.server.value.ItemUnitPriceLimitValue;
035import com.echothree.model.data.uom.server.entity.UnitOfMeasureType;
036import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.EditMode;
041import com.echothree.util.common.form.BaseForm;
042import com.echothree.util.server.control.BaseAbstractEditCommand;
043import com.echothree.util.server.persistence.Session;
044import com.echothree.util.server.string.AmountUtils;
045import com.echothree.util.server.validation.Validator;
046import java.util.Arrays;
047import java.util.Collections;
048import java.util.List;
049
050public class EditItemUnitPriceLimitCommand
051        extends BaseAbstractEditCommand<ItemUnitPriceLimitSpec, ItemUnitPriceLimitEdit, EditItemUnitPriceLimitResult, ItemUnitPriceLimit, ItemUnitPriceLimit> {
052    
053    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
054    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
055    
056    static {
057        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("InventoryConditionName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("UnitOfMeasureTypeName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("CurrencyIsoName", FieldType.ENTITY_NAME, true, null, null)
062                ));
063        
064        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
065                new FieldDefinition("MinimumUnitPrice", FieldType.UNSIGNED_PRICE_UNIT, false, null, null),
066                new FieldDefinition("MaximumUnitPrice", FieldType.UNSIGNED_PRICE_UNIT, false, null, null)
067                ));
068    }
069    
070    /** Creates a new instance of EditItemUnitPriceLimitCommand */
071    public EditItemUnitPriceLimitCommand(UserVisitPK userVisitPK, EditItemUnitPriceLimitForm form) {
072        super(userVisitPK, form, null, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
073    }
074    
075    @Override
076    protected void setupValidatorForEdit(Validator validator, BaseForm specForm) {
077        var accountingControl = Session.getModelController(AccountingControl.class);
078        String currencyIsoName = spec.getCurrencyIsoName();
079        
080        validator.setCurrency(accountingControl.getCurrencyByIsoName(currencyIsoName));
081    }
082    
083    @Override
084    public EditItemUnitPriceLimitResult getResult() {
085        return ItemResultFactory.getEditItemUnitPriceLimitResult();
086    }
087
088    @Override
089    public ItemUnitPriceLimitEdit getEdit() {
090        return ItemEditFactory.getItemUnitPriceLimitEdit();
091    }
092
093    Currency currency;
094
095    @Override
096    public ItemUnitPriceLimit getEntity(EditItemUnitPriceLimitResult result) {
097        var itemControl = Session.getModelController(ItemControl.class);
098        ItemUnitPriceLimit itemUnitPriceLimit = null;
099        String itemName = spec.getItemName();
100        Item item = itemControl.getItemByName(itemName);
101
102        if(item != null) {
103            var inventoryControl = Session.getModelController(InventoryControl.class);
104            String inventoryConditionName = spec.getInventoryConditionName();
105            InventoryCondition inventoryCondition = inventoryControl.getInventoryConditionByName(inventoryConditionName);
106
107            if(inventoryCondition != null) {
108                var uomControl = Session.getModelController(UomControl.class);
109                ItemDetail itemDetail = item.getLastDetail();
110                String unitOfMeasureTypeName = spec.getUnitOfMeasureTypeName();
111                UnitOfMeasureType unitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(itemDetail.getUnitOfMeasureKind(), unitOfMeasureTypeName);
112
113                if(unitOfMeasureType != null) {
114                    var accountingControl = Session.getModelController(AccountingControl.class);
115                    String currencyIsoName = spec.getCurrencyIsoName();
116
117                    currency = accountingControl.getCurrencyByIsoName(currencyIsoName);
118
119                    if(currency != null) {
120                        itemUnitPriceLimit = itemControl.getItemUnitPriceLimit(item, inventoryCondition, unitOfMeasureType, currency);
121
122                        if(itemUnitPriceLimit != null) {
123                            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
124                                itemUnitPriceLimit = itemControl.getItemUnitPriceLimit(item, inventoryCondition, unitOfMeasureType, currency);
125                            } else { // EditMode.UPDATE
126                                itemUnitPriceLimit = itemControl.getItemUnitPriceLimitForUpdate(item, inventoryCondition, unitOfMeasureType, currency);
127                            }
128
129                            if(itemUnitPriceLimit == null) {
130                                addExecutionError(ExecutionErrors.UnknownItemUnitPriceLimit.name(), itemName, inventoryConditionName, unitOfMeasureTypeName);
131                            }
132                        } else {
133                            addExecutionError(ExecutionErrors.UnknownItemUnitPriceLimit.name(), itemName, inventoryConditionName, unitOfMeasureTypeName, currencyIsoName);
134                        }
135                    } else {
136                        addExecutionError(ExecutionErrors.UnknownCurrencyIsoName.name(), currencyIsoName);
137                    }
138                } else {
139                    addExecutionError(ExecutionErrors.UnknownUnitOfMeasureTypeName.name(), unitOfMeasureTypeName);
140                }
141            } else {
142                addExecutionError(ExecutionErrors.UnknownInventoryConditionName.name(), inventoryConditionName);
143            }
144        } else {
145            addExecutionError(ExecutionErrors.UnknownItemName.name(), itemName);
146        }
147
148        return itemUnitPriceLimit;
149    }
150
151    @Override
152    public ItemUnitPriceLimit getLockEntity(ItemUnitPriceLimit itemUnitPriceLimit) {
153        return itemUnitPriceLimit;
154    }
155
156    @Override
157    public void fillInResult(EditItemUnitPriceLimitResult result, ItemUnitPriceLimit itemUnitPriceLimit) {
158        var itemControl = Session.getModelController(ItemControl.class);
159
160        result.setItemUnitPriceLimit(itemControl.getItemUnitPriceLimitTransfer(getUserVisit(), itemUnitPriceLimit));
161    }
162
163    @Override
164    public void doLock(ItemUnitPriceLimitEdit edit, ItemUnitPriceLimit itemUnitPriceLimit) {
165        edit.setMinimumUnitPrice(AmountUtils.getInstance().formatPriceUnit(currency, itemUnitPriceLimit.getMinimumUnitPrice()));
166        edit.setMaximumUnitPrice(AmountUtils.getInstance().formatPriceUnit(currency, itemUnitPriceLimit.getMaximumUnitPrice()));
167    }
168
169    Long minimumUnitPrice;
170    Long maximumUnitPrice;
171
172    @Override
173    public void canUpdate(ItemUnitPriceLimit itemUnitPriceLimit) {
174        String strMinimumUnitPrice = edit.getMinimumUnitPrice();
175        String strMaximumUnitPrice = edit.getMaximumUnitPrice();
176
177        if(strMinimumUnitPrice != null) {
178            minimumUnitPrice = Long.valueOf(strMinimumUnitPrice);
179        } else {
180            addExecutionError(ExecutionErrors.MissingMinimumUnitPrice.name());
181        }
182
183        if(strMaximumUnitPrice != null) {
184            maximumUnitPrice = Long.valueOf(strMaximumUnitPrice);
185        } else {
186            addExecutionError(ExecutionErrors.MissingMaximumUnitPrice.name());
187        }
188        
189        if(minimumUnitPrice != null && maximumUnitPrice != null) {
190            if(maximumUnitPrice < minimumUnitPrice) {
191                addExecutionError(ExecutionErrors.MaximumUnitPriceLessThanMinimumUnitPrice.name());
192            }
193        }
194    }
195
196    @Override
197    public void doUpdate(ItemUnitPriceLimit itemUnitPriceLimit) {
198        var itemControl = Session.getModelController(ItemControl.class);
199        ItemUnitPriceLimitValue itemUnitPriceLimitValue = itemControl.getItemUnitPriceLimitValue(itemUnitPriceLimit);
200
201        itemUnitPriceLimitValue.setMinimumUnitPrice(minimumUnitPrice);
202        itemUnitPriceLimitValue.setMaximumUnitPrice(maximumUnitPrice);
203
204        itemControl.updateItemUnitPriceLimitFromValue(itemUnitPriceLimitValue, getPartyPK());
205    }
206    
207}