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