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.InventoryConditionControl;
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.string.AmountUtils;
045import com.echothree.util.server.validation.Validator;
046import java.util.List;
047import javax.enterprise.context.Dependent;
048import javax.inject.Inject;
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    @Inject
082    AccountingControl accountingControl;
083
084    @Inject
085    InventoryConditionControl inventoryConditionControl;
086
087    @Inject
088    ItemControl itemControl;
089
090    @Inject
091    UomControl uomControl;
092
093    
094    /** Creates a new instance of EditItemPriceCommand */
095    public EditItemPriceCommand() {
096        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
097    }
098    
099    @Override
100    protected void setupValidatorForEdit(Validator validator, BaseForm specForm) {
101        var currencyIsoName = spec.getCurrencyIsoName();
102        
103        validator.setCurrency(accountingControl.getCurrencyByIsoName(currencyIsoName));
104    }
105    
106    @Override
107    public EditItemPriceResult getResult() {
108        return ItemResultFactory.getEditItemPriceResult();
109    }
110
111    @Override
112    public ItemPriceEdit getEdit() {
113        return ItemEditFactory.getItemPriceEdit();
114    }
115
116    Currency currency;
117    String itemPriceTypeName;
118
119    @Override
120    public ItemPrice getEntity(EditItemPriceResult result) {
121        ItemPrice itemPrice = null;
122        var itemName = spec.getItemName();
123        var item = itemControl.getItemByName(itemName);
124
125        if(item != null) {
126            var inventoryConditionName = spec.getInventoryConditionName();
127            var inventoryCondition = inventoryConditionControl.getInventoryConditionByName(inventoryConditionName);
128
129            if(inventoryCondition != null) {
130                var itemDetail = item.getLastDetail();
131                var unitOfMeasureTypeName = spec.getUnitOfMeasureTypeName();
132                var unitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(itemDetail.getUnitOfMeasureKind(), unitOfMeasureTypeName);
133
134                if(unitOfMeasureType != null) {
135                    var 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        result.setItemPrice(itemControl.getItemPriceTransfer(getUserVisit(), itemPrice));
171    }
172
173    @Override
174    public void doLock(ItemPriceEdit edit, ItemPrice itemPrice) {
175        if(itemPriceTypeName.equals(ItemPriceTypes.FIXED.name())) {
176            var itemFixedPrice = itemControl.getItemFixedPrice(itemPrice);
177
178            edit.setUnitPrice(AmountUtils.getInstance().formatPriceUnit(currency, itemFixedPrice.getUnitPrice()));
179        } else if(itemPriceTypeName.equals(ItemPriceTypes.VARIABLE.name())) {
180            var itemVariablePrice = itemControl.getItemVariablePrice(itemPrice);
181
182            edit.setMinimumUnitPrice(AmountUtils.getInstance().formatPriceUnit(currency, itemVariablePrice.getMinimumUnitPrice()));
183            edit.setMaximumUnitPrice(AmountUtils.getInstance().formatPriceUnit(currency, itemVariablePrice.getMaximumUnitPrice()));
184            edit.setUnitPriceIncrement(AmountUtils.getInstance().formatPriceUnit(currency, itemVariablePrice.getUnitPriceIncrement()));
185        } else {
186            addExecutionError(ExecutionErrors.UnknownItemPriceType.name(), itemPriceTypeName);
187        }
188    }
189
190    Long unitPrice;
191    Long minimumUnitPrice;
192    Long maximumUnitPrice;
193    Long unitPriceIncrement;
194
195    @Override
196    public void canUpdate(ItemPrice itemPrice) {
197        if(itemPriceTypeName.equals(ItemPriceTypes.FIXED.name())) {
198            var strUnitPrice = edit.getUnitPrice();
199
200            if(strUnitPrice != null) {
201                unitPrice = Long.valueOf(strUnitPrice);
202            } else {
203                addExecutionError(ExecutionErrors.MissingUnitPrice.name());
204            }
205        } else if(itemPriceTypeName.equals(ItemPriceTypes.VARIABLE.name())) {
206            var strMinimumUnitPrice = edit.getMinimumUnitPrice();
207            var strMaximumUnitPrice = edit.getMaximumUnitPrice();
208            var strUnitPriceIncrement = edit.getUnitPriceIncrement();
209
210            if(strMinimumUnitPrice != null) {
211                minimumUnitPrice = Long.valueOf(strMinimumUnitPrice);
212            } else {
213                addExecutionError(ExecutionErrors.MissingMinimumUnitPrice.name());
214            }
215
216            if(strMaximumUnitPrice != null) {
217                maximumUnitPrice = Long.valueOf(strMaximumUnitPrice);
218            } else {
219                addExecutionError(ExecutionErrors.MissingMaximumUnitPrice.name());
220            }
221
222            if(strUnitPriceIncrement != null) {
223                unitPriceIncrement = Long.valueOf(strUnitPriceIncrement);
224            } else {
225                addExecutionError(ExecutionErrors.MissingUnitPriceIncrement.name());
226            }
227        } else {
228            addExecutionError(ExecutionErrors.UnknownItemPriceType.name(), itemPriceTypeName);
229        }
230    }
231
232    @Override
233    public void doUpdate(ItemPrice itemPrice) {
234        if(itemPriceTypeName.equals(ItemPriceTypes.FIXED.name())) {
235            var itemFixedPriceValue = itemControl.getItemFixedPriceValueForUpdate(itemPrice);
236
237            itemFixedPriceValue.setUnitPrice(unitPrice);
238
239            itemControl.updateItemFixedPriceFromValue(itemFixedPriceValue, getPartyPK());
240        } else if(itemPriceTypeName.equals(ItemPriceTypes.VARIABLE.name())) {
241            var itemVariablePriceValue = itemControl.getItemVariablePriceValueForUpdate(itemPrice);
242
243            itemVariablePriceValue.setMinimumUnitPrice(minimumUnitPrice);
244            itemVariablePriceValue.setMaximumUnitPrice(maximumUnitPrice);
245            itemVariablePriceValue.setUnitPriceIncrement(unitPriceIncrement);
246
247            itemControl.updateItemVariablePriceFromValue(itemVariablePriceValue, getPartyPK());
248        }
249    }
250    
251}