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