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.ItemPriceEdit;
021import com.echothree.control.user.item.common.form.EditItemPriceForm;
022import com.echothree.control.user.item.common.result.EditItemPriceResult;
023import com.echothree.control.user.item.common.result.ItemResultFactory;
024import com.echothree.control.user.item.common.spec.ItemPriceSpec;
025import com.echothree.model.control.accounting.server.control.AccountingControl;
026import com.echothree.model.control.inventory.server.control.InventoryControl;
027import com.echothree.model.control.item.common.ItemPriceTypes;
028import com.echothree.model.control.item.server.control.ItemControl;
029import com.echothree.model.control.party.common.PartyTypes;
030import com.echothree.model.control.security.common.SecurityRoleGroups;
031import com.echothree.model.control.security.common.SecurityRoles;
032import com.echothree.model.control.uom.server.control.UomControl;
033import com.echothree.model.data.accounting.server.entity.Currency;
034import com.echothree.model.data.inventory.server.entity.InventoryCondition;
035import com.echothree.model.data.item.server.entity.Item;
036import com.echothree.model.data.item.server.entity.ItemDetail;
037import com.echothree.model.data.item.server.entity.ItemFixedPrice;
038import com.echothree.model.data.item.server.entity.ItemPrice;
039import com.echothree.model.data.item.server.entity.ItemVariablePrice;
040import com.echothree.model.data.item.server.value.ItemFixedPriceValue;
041import com.echothree.model.data.item.server.value.ItemVariablePriceValue;
042import com.echothree.model.data.uom.server.entity.UnitOfMeasureType;
043import com.echothree.model.data.user.common.pk.UserVisitPK;
044import com.echothree.util.common.message.ExecutionErrors;
045import com.echothree.util.common.validation.FieldDefinition;
046import com.echothree.util.common.validation.FieldType;
047import com.echothree.util.common.form.BaseForm;
048import com.echothree.util.server.control.BaseAbstractEditCommand;
049import com.echothree.util.server.control.CommandSecurityDefinition;
050import com.echothree.util.server.control.PartyTypeDefinition;
051import com.echothree.util.server.control.SecurityRoleDefinition;
052import com.echothree.util.server.persistence.Session;
053import com.echothree.util.server.string.AmountUtils;
054import com.echothree.util.server.validation.Validator;
055import java.util.Arrays;
056import java.util.Collections;
057import java.util.List;
058
059public class EditItemPriceCommand
060        extends BaseAbstractEditCommand<ItemPriceSpec, ItemPriceEdit, EditItemPriceResult, ItemPrice, ItemPrice> {
061
062    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
063    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
064    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
065    
066    static {
067        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
068                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
069                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
070                        new SecurityRoleDefinition(SecurityRoleGroups.ItemPrice.name(), SecurityRoles.Edit.name())
071                )))
072        )));
073
074        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
075                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
076                new FieldDefinition("InventoryConditionName", FieldType.ENTITY_NAME, true, null, null),
077                new FieldDefinition("UnitOfMeasureTypeName", FieldType.ENTITY_NAME, true, null, null),
078                new FieldDefinition("CurrencyIsoName", FieldType.ENTITY_NAME, true, null, null)
079                ));
080        
081        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
082                new FieldDefinition("UnitPrice", FieldType.UNSIGNED_PRICE_UNIT, false, null, null),
083                new FieldDefinition("MinimumUnitPrice", FieldType.UNSIGNED_PRICE_UNIT, false, null, null),
084                new FieldDefinition("MaximumUnitPrice", FieldType.UNSIGNED_PRICE_UNIT, false, null, null),
085                new FieldDefinition("UnitPriceIncrement", FieldType.UNSIGNED_PRICE_UNIT, false, null, null)
086                ));
087    }
088    
089    /** Creates a new instance of EditItemPriceCommand */
090    public EditItemPriceCommand(UserVisitPK userVisitPK, EditItemPriceForm form) {
091        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
092    }
093    
094    @Override
095    protected void setupValidatorForEdit(Validator validator, BaseForm specForm) {
096        var accountingControl = Session.getModelController(AccountingControl.class);
097        String currencyIsoName = spec.getCurrencyIsoName();
098        
099        validator.setCurrency(accountingControl.getCurrencyByIsoName(currencyIsoName));
100    }
101    
102    @Override
103    public EditItemPriceResult getResult() {
104        return ItemResultFactory.getEditItemPriceResult();
105    }
106
107    @Override
108    public ItemPriceEdit getEdit() {
109        return ItemEditFactory.getItemPriceEdit();
110    }
111
112    Currency currency;
113    String itemPriceTypeName;
114
115    @Override
116    public ItemPrice getEntity(EditItemPriceResult result) {
117        var itemControl = Session.getModelController(ItemControl.class);
118        ItemPrice itemPrice = null;
119        String itemName = spec.getItemName();
120        Item item = itemControl.getItemByName(itemName);
121
122        if(item != null) {
123            var inventoryControl = Session.getModelController(InventoryControl.class);
124            String inventoryConditionName = spec.getInventoryConditionName();
125            InventoryCondition inventoryCondition = inventoryControl.getInventoryConditionByName(inventoryConditionName);
126
127            if(inventoryCondition != null) {
128                var uomControl = Session.getModelController(UomControl.class);
129                ItemDetail itemDetail = item.getLastDetail();
130                String unitOfMeasureTypeName = spec.getUnitOfMeasureTypeName();
131                UnitOfMeasureType unitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(itemDetail.getUnitOfMeasureKind(), unitOfMeasureTypeName);
132
133                if(unitOfMeasureType != null) {
134                    var accountingControl = Session.getModelController(AccountingControl.class);
135                    String currencyIsoName = spec.getCurrencyIsoName();
136
137                    currency = accountingControl.getCurrencyByIsoName(currencyIsoName);
138
139                    if(currency != null) {
140                        itemPrice = itemControl.getItemPrice(item, inventoryCondition, unitOfMeasureType, currency);
141
142                        if(itemPrice != null) {
143                            itemPriceTypeName = itemDetail.getItemPriceType().getItemPriceTypeName();
144                        } else {
145                            addExecutionError(ExecutionErrors.UnknownItemPrice.name(), itemName, inventoryConditionName, unitOfMeasureTypeName, currencyIsoName);
146                        }
147                    } else {
148                        addExecutionError(ExecutionErrors.UnknownCurrencyIsoName.name(), currencyIsoName);
149                    }
150                } else {
151                    addExecutionError(ExecutionErrors.UnknownUnitOfMeasureTypeName.name(), unitOfMeasureTypeName);
152                }
153            } else {
154                addExecutionError(ExecutionErrors.UnknownInventoryConditionName.name(), inventoryConditionName);
155            }
156        } else {
157            addExecutionError(ExecutionErrors.UnknownItemName.name(), itemName);
158        }
159
160        return itemPrice;
161    }
162
163    @Override
164    public ItemPrice getLockEntity(ItemPrice itemPrice) {
165        return itemPrice;
166    }
167
168    @Override
169    public void fillInResult(EditItemPriceResult result, ItemPrice itemPrice) {
170        var itemControl = Session.getModelController(ItemControl.class);
171
172        result.setItemPrice(itemControl.getItemPriceTransfer(getUserVisit(), itemPrice));
173    }
174
175    @Override
176    public void doLock(ItemPriceEdit edit, ItemPrice itemPrice) {
177        var itemControl = Session.getModelController(ItemControl.class);
178
179        if(itemPriceTypeName.equals(ItemPriceTypes.FIXED.name())) {
180            ItemFixedPrice itemFixedPrice = itemControl.getItemFixedPrice(itemPrice);
181
182            edit.setUnitPrice(AmountUtils.getInstance().formatPriceUnit(currency, itemFixedPrice.getUnitPrice()));
183        } else if(itemPriceTypeName.equals(ItemPriceTypes.VARIABLE.name())) {
184            ItemVariablePrice itemVariablePrice = itemControl.getItemVariablePrice(itemPrice);
185
186            edit.setMinimumUnitPrice(AmountUtils.getInstance().formatPriceUnit(currency, itemVariablePrice.getMinimumUnitPrice()));
187            edit.setMaximumUnitPrice(AmountUtils.getInstance().formatPriceUnit(currency, itemVariablePrice.getMaximumUnitPrice()));
188            edit.setUnitPriceIncrement(AmountUtils.getInstance().formatPriceUnit(currency, itemVariablePrice.getUnitPriceIncrement()));
189        } else {
190            addExecutionError(ExecutionErrors.UnknownItemPriceType.name(), itemPriceTypeName);
191        }
192    }
193
194    Long unitPrice;
195    Long minimumUnitPrice;
196    Long maximumUnitPrice;
197    Long unitPriceIncrement;
198
199    @Override
200    public void canUpdate(ItemPrice itemPrice) {
201        if(itemPriceTypeName.equals(ItemPriceTypes.FIXED.name())) {
202            String strUnitPrice = edit.getUnitPrice();
203
204            if(strUnitPrice != null) {
205                unitPrice = Long.valueOf(strUnitPrice);
206            } else {
207                addExecutionError(ExecutionErrors.MissingUnitPrice.name());
208            }
209        } else if(itemPriceTypeName.equals(ItemPriceTypes.VARIABLE.name())) {
210            String strMinimumUnitPrice = edit.getMinimumUnitPrice();
211            String strMaximumUnitPrice = edit.getMaximumUnitPrice();
212            String strUnitPriceIncrement = edit.getUnitPriceIncrement();
213
214            if(strMinimumUnitPrice != null) {
215                minimumUnitPrice = Long.valueOf(strMinimumUnitPrice);
216            } else {
217                addExecutionError(ExecutionErrors.MissingMinimumUnitPrice.name());
218            }
219
220            if(strMaximumUnitPrice != null) {
221                maximumUnitPrice = Long.valueOf(strMaximumUnitPrice);
222            } else {
223                addExecutionError(ExecutionErrors.MissingMaximumUnitPrice.name());
224            }
225
226            if(strUnitPriceIncrement != null) {
227                unitPriceIncrement = Long.valueOf(strUnitPriceIncrement);
228            } else {
229                addExecutionError(ExecutionErrors.MissingUnitPriceIncrement.name());
230            }
231        } else {
232            addExecutionError(ExecutionErrors.UnknownItemPriceType.name(), itemPriceTypeName);
233        }
234    }
235
236    @Override
237    public void doUpdate(ItemPrice itemPrice) {
238        var itemControl = Session.getModelController(ItemControl.class);
239        if(itemPriceTypeName.equals(ItemPriceTypes.FIXED.name())) {
240            ItemFixedPriceValue itemFixedPriceValue = itemControl.getItemFixedPriceValueForUpdate(itemPrice);
241
242            itemFixedPriceValue.setUnitPrice(unitPrice);
243
244            itemControl.updateItemFixedPriceFromValue(itemFixedPriceValue, getPartyPK());
245        } else if(itemPriceTypeName.equals(ItemPriceTypes.VARIABLE.name())) {
246            ItemVariablePriceValue itemVariablePriceValue = itemControl.getItemVariablePriceValueForUpdate(itemPrice);
247
248            itemVariablePriceValue.setMinimumUnitPrice(minimumUnitPrice);
249            itemVariablePriceValue.setMaximumUnitPrice(maximumUnitPrice);
250            itemVariablePriceValue.setUnitPriceIncrement(unitPriceIncrement);
251
252            itemControl.updateItemVariablePriceFromValue(itemVariablePriceValue, getPartyPK());
253        }
254    }
255    
256}