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.tax.server.command;
018
019import com.echothree.control.user.tax.common.edit.ItemTaxClassificationEdit;
020import com.echothree.control.user.tax.common.edit.TaxEditFactory;
021import com.echothree.control.user.tax.common.form.EditItemTaxClassificationForm;
022import com.echothree.control.user.tax.common.result.EditItemTaxClassificationResult;
023import com.echothree.control.user.tax.common.result.TaxResultFactory;
024import com.echothree.control.user.tax.common.spec.ItemTaxClassificationSpec;
025import com.echothree.model.control.geo.server.control.GeoControl;
026import com.echothree.model.control.item.server.control.ItemControl;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.control.tax.server.control.TaxControl;
031import com.echothree.model.data.geo.server.entity.GeoCode;
032import com.echothree.model.data.tax.server.entity.ItemTaxClassification;
033import com.echothree.model.data.tax.server.entity.TaxClassification;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.EditMode;
039import com.echothree.util.server.control.BaseAbstractEditCommand;
040import com.echothree.util.server.control.CommandSecurityDefinition;
041import com.echothree.util.server.control.PartyTypeDefinition;
042import com.echothree.util.server.control.SecurityRoleDefinition;
043import java.util.List;
044import javax.enterprise.context.Dependent;
045import javax.inject.Inject;
046
047@Dependent
048public class EditItemTaxClassificationCommand
049        extends BaseAbstractEditCommand<ItemTaxClassificationSpec, ItemTaxClassificationEdit, EditItemTaxClassificationResult, ItemTaxClassification, ItemTaxClassification> {
050
051    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
052    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
053    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
054
055    static {
056        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
057                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
058                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
059                        new SecurityRoleDefinition(SecurityRoleGroups.ItemTaxClassification.name(), SecurityRoles.Edit.name())
060                ))
061        ));
062
063        SPEC_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null)
066        );
067
068        EDIT_FIELD_DEFINITIONS = List.of(
069                new FieldDefinition("TaxClassificationName", FieldType.ENTITY_NAME, true, null, null)
070        );
071    }
072
073    @Inject
074    GeoControl geoControl;
075
076    @Inject
077    ItemControl itemControl;
078
079    @Inject
080    TaxControl taxControl;
081
082    /** Creates a new instance of EditItemTaxClassificationCommand */
083    public EditItemTaxClassificationCommand() {
084        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
085    }
086
087    @Override
088    public EditItemTaxClassificationResult getResult() {
089        return TaxResultFactory.getEditItemTaxClassificationResult();
090    }
091
092    @Override
093    public ItemTaxClassificationEdit getEdit() {
094        return TaxEditFactory.getItemTaxClassificationEdit();
095    }
096
097    GeoCode countryGeoCode;
098
099    @Override
100    public ItemTaxClassification getEntity(EditItemTaxClassificationResult result) {
101        ItemTaxClassification itemTaxClassification = null;
102        var itemName = spec.getItemName();
103        var item = itemControl.getItemByName(itemName);
104        
105        if(item != null) {
106            var countryName = spec.getCountryName();
107            
108            countryGeoCode = geoControl.getCountryByAlias(countryName);
109            
110            if(countryGeoCode != null) {
111                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
112                    itemTaxClassification = taxControl.getItemTaxClassification(item, countryGeoCode);
113                } else { // EditMode.UPDATE
114                    itemTaxClassification = taxControl.getItemTaxClassificationForUpdate(item, countryGeoCode);
115                }
116
117                if(itemTaxClassification == null) {
118                    addExecutionError(ExecutionErrors.UnknownItemTaxClassification.name(), itemName, countryName);
119                }
120            } else {
121                addExecutionError(ExecutionErrors.UnknownCountryName.name(), countryName);
122            }
123        } else {
124            addExecutionError(ExecutionErrors.UnknownItemName.name(), itemName);
125        }
126
127        return itemTaxClassification;
128    }
129
130    @Override
131    public ItemTaxClassification getLockEntity(ItemTaxClassification itemTaxClassification) {
132        return itemTaxClassification;
133    }
134
135    @Override
136    public void fillInResult(EditItemTaxClassificationResult result, ItemTaxClassification itemTaxClassification) {
137        result.setItemTaxClassification(taxControl.getItemTaxClassificationTransfer(getUserVisit(), itemTaxClassification));
138    }
139
140    @Override
141    public void doLock(ItemTaxClassificationEdit edit, ItemTaxClassification itemTaxClassification) {
142        var itemTaxClassificationDetail = itemTaxClassification.getLastDetail();
143        
144        edit.setTaxClassificationName(itemTaxClassificationDetail.getTaxClassification().getLastDetail().getTaxClassificationName());
145    }
146
147    TaxClassification harmonizedTariffScheduleCode;
148    
149    @Override
150    public void canUpdate(ItemTaxClassification itemTaxClassification) {
151        var harmonizedTariffScheduleCodeName = edit.getTaxClassificationName();
152        
153        harmonizedTariffScheduleCode = taxControl.getTaxClassificationByName(countryGeoCode, harmonizedTariffScheduleCodeName);
154
155        if(harmonizedTariffScheduleCode == null) {
156            addExecutionError(ExecutionErrors.UnknownTaxClassificationName.name(), spec.getCountryName(), harmonizedTariffScheduleCodeName);
157        }
158    }
159
160    @Override
161    public void doUpdate(ItemTaxClassification itemTaxClassification) {
162        var itemTaxClassificationDetailValue = taxControl.getItemTaxClassificationDetailValueForUpdate(itemTaxClassification);
163        
164        itemTaxClassificationDetailValue.setTaxClassificationPK(harmonizedTariffScheduleCode.getPrimaryKey());
165        
166        taxControl.updateItemTaxClassificationFromValue(itemTaxClassificationDetailValue, getPartyPK());
167    }
168
169}