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.offer.server.command;
018
019import com.echothree.control.user.offer.common.edit.OfferEditFactory;
020import com.echothree.control.user.offer.common.edit.OfferItemPriceEdit;
021import com.echothree.control.user.offer.common.result.EditOfferItemPriceResult;
022import com.echothree.control.user.offer.common.result.OfferResultFactory;
023import com.echothree.control.user.offer.common.spec.OfferItemPriceSpec;
024import com.echothree.model.control.accounting.server.control.AccountingControl;
025import com.echothree.model.control.item.common.ItemPriceTypes;
026import com.echothree.model.control.offer.server.control.OfferItemControl;
027import com.echothree.model.control.offer.server.logic.OfferItemLogic;
028import com.echothree.model.control.offer.server.logic.OfferItemPriceLogic;
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.data.offer.server.entity.OfferItem;
033import com.echothree.model.data.offer.server.entity.OfferItemPrice;
034import com.echothree.util.common.form.BaseForm;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.server.control.BaseAbstractEditCommand;
039import com.echothree.util.server.control.CommandSecurityDefinition;
040import com.echothree.util.server.control.PartyTypeDefinition;
041import com.echothree.util.server.control.SecurityRoleDefinition;
042import com.echothree.util.server.string.AmountUtils;
043import com.echothree.util.server.validation.Validator;
044import java.util.List;
045import javax.enterprise.context.Dependent;
046import javax.inject.Inject;
047
048@Dependent
049public class EditOfferItemPriceCommand
050        extends BaseAbstractEditCommand<OfferItemPriceSpec, OfferItemPriceEdit, EditOfferItemPriceResult, OfferItemPrice, OfferItem> {
051
052    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
053    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
054    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
055
056    static {
057        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
060                        new SecurityRoleDefinition(SecurityRoleGroups.OfferItemPrice.name(), SecurityRoles.Edit.name())
061                ))
062        ));
063
064        SPEC_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("OfferName", FieldType.ENTITY_NAME, true, null, 20L),
066                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("InventoryConditionName", FieldType.ENTITY_NAME, true, null, null),
068                new FieldDefinition("UnitOfMeasureTypeName", FieldType.ENTITY_NAME, true, null, null),
069                new FieldDefinition("CurrencyIsoName", FieldType.ENTITY_NAME, true, null, null)
070        );
071
072        EDIT_FIELD_DEFINITIONS = List.of(
073                new FieldDefinition("UnitPrice", FieldType.UNSIGNED_PRICE_UNIT, false, null, null),
074                new FieldDefinition("MinimumUnitPrice", FieldType.UNSIGNED_PRICE_UNIT, false, null, null),
075                new FieldDefinition("MaximumUnitPrice", FieldType.UNSIGNED_PRICE_UNIT, false, null, null),
076                new FieldDefinition("UnitPriceIncrement", FieldType.UNSIGNED_PRICE_UNIT, false, null, null)
077        );
078    }
079
080    @Inject
081    AccountingControl accountingControl;
082
083    @Inject
084    OfferItemControl offerItemControl;
085
086    @Inject
087    OfferItemLogic offerItemLogic;
088
089    @Inject
090    OfferItemPriceLogic offerItemPriceLogic;
091
092    /** Creates a new instance of EditOfferItemPriceCommand */
093    public EditOfferItemPriceCommand() {
094        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
095    }
096
097    @Override
098    protected void setupValidatorForEdit(Validator validator, BaseForm specForm) {
099        var currencyIsoName = spec.getCurrencyIsoName();
100
101        validator.setCurrency(accountingControl.getCurrencyByIsoName(currencyIsoName));
102    }
103
104    @Override
105    public EditOfferItemPriceResult getResult() {
106        return OfferResultFactory.getEditOfferItemPriceResult();
107    }
108
109    @Override
110    public OfferItemPriceEdit getEdit() {
111        return OfferEditFactory.getOfferItemPriceEdit();
112    }
113
114    @Override
115    public OfferItemPrice getEntity(EditOfferItemPriceResult result) {
116        return offerItemPriceLogic.getOfferItemPriceBySpec(this, spec, editModeToEntityPermission(editMode));
117    }
118
119    @Override
120    public OfferItem getLockEntity(OfferItemPrice offerItemPrice) {
121        return offerItemPrice.getOfferItem();
122    }
123
124    @Override
125    public void fillInResult(EditOfferItemPriceResult result, OfferItemPrice offerItemPrice) {
126        result.setOfferItemPrice(offerItemControl.getOfferItemPriceTransfer(getUserVisit(), offerItemPrice));
127    }
128
129    @Override
130    public void canEdit(OfferItemPrice offerItemPrice) {
131        var offerDetail = offerItemPrice.getOfferItem().getOffer().getLastDetail();
132
133        if(offerDetail.getOfferItemPriceFilter() != null) {
134            addExecutionError(ExecutionErrors.CannotManuallyEditOfferItemPriceWhenOfferItemPriceFilterSet.name(), offerDetail.getOfferName());
135        }
136    }
137
138    private String getItemPriceTypeName(OfferItemPrice offerItemPrice) {
139        return offerItemPrice.getOfferItem().getItem().getLastDetail().getItemPriceType().getItemPriceTypeName();
140    }
141
142    @Override
143    public void doLock(OfferItemPriceEdit edit, OfferItemPrice offerItemPrice) {
144        var itemPriceTypeName = getItemPriceTypeName(offerItemPrice);
145        var currency = offerItemPrice.getCurrency();
146        var amountUtils = AmountUtils.getInstance();
147
148        if(itemPriceTypeName.equals(ItemPriceTypes.FIXED.name())) {
149            var offerItemFixedPrice = offerItemControl.getOfferItemFixedPrice(offerItemPrice);
150
151            edit.setUnitPrice(amountUtils.formatPriceUnit(currency, offerItemFixedPrice.getUnitPrice()));
152        } else if(itemPriceTypeName.equals(ItemPriceTypes.VARIABLE.name())) {
153            var offerItemVariablePrice = offerItemControl.getOfferItemVariablePrice(offerItemPrice);
154
155            edit.setMinimumUnitPrice(amountUtils.formatPriceUnit(currency, offerItemVariablePrice.getMinimumUnitPrice()));
156            edit.setMaximumUnitPrice(amountUtils.formatPriceUnit(currency, offerItemVariablePrice.getMaximumUnitPrice()));
157            edit.setUnitPriceIncrement(amountUtils.formatPriceUnit(currency, offerItemVariablePrice.getUnitPriceIncrement()));
158        } else {
159            addExecutionError(ExecutionErrors.UnknownItemPriceType.name(), itemPriceTypeName);
160        }
161    }
162
163    @Override
164    public void canUpdate(OfferItemPrice offerItemPrice) {
165        var itemPriceTypeName = getItemPriceTypeName(offerItemPrice);
166
167        if(itemPriceTypeName.equals(ItemPriceTypes.FIXED.name())) {
168            if(edit.getUnitPrice() == null) {
169                addExecutionError(ExecutionErrors.MissingUnitPrice.name());
170            }
171        } else if(itemPriceTypeName.equals(ItemPriceTypes.VARIABLE.name())) {
172            if(edit.getMinimumUnitPrice() == null) {
173                addExecutionError(ExecutionErrors.MissingMinimumUnitPrice.name());
174            }
175            if(edit.getMaximumUnitPrice() == null) {
176                addExecutionError(ExecutionErrors.MissingMaximumUnitPrice.name());
177            }
178            if(edit.getUnitPriceIncrement() == null) {
179                addExecutionError(ExecutionErrors.MissingUnitPriceIncrement.name());
180            }
181        } else {
182            addExecutionError(ExecutionErrors.UnknownItemPriceType.name(), itemPriceTypeName);
183        }
184    }
185
186    @Override
187    public void doUpdate(OfferItemPrice offerItemPrice) {
188        if(getItemPriceTypeName(offerItemPrice).equals(ItemPriceTypes.FIXED.name())) {
189            var offerItemFixedPriceValue = offerItemControl.getOfferItemFixedPriceValueForUpdate(offerItemPrice);
190
191            offerItemFixedPriceValue.setUnitPrice(Long.valueOf(edit.getUnitPrice()));
192
193            offerItemLogic.updateOfferItemFixedPriceFromValue(offerItemFixedPriceValue, getPartyPK());
194        } else {
195            var offerItemVariablePriceValue = offerItemControl.getOfferItemVariablePriceValueForUpdate(offerItemPrice);
196
197            offerItemVariablePriceValue.setMinimumUnitPrice(Long.valueOf(edit.getMinimumUnitPrice()));
198            offerItemVariablePriceValue.setMaximumUnitPrice(Long.valueOf(edit.getMaximumUnitPrice()));
199            offerItemVariablePriceValue.setUnitPriceIncrement(Long.valueOf(edit.getUnitPriceIncrement()));
200
201            offerItemLogic.updateOfferItemVariablePriceFromValue(offerItemVariablePriceValue, getPartyPK());
202        }
203    }
204
205}