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.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 com.echothree.util.server.persistence.Session;
044import java.util.Arrays;
045import java.util.Collections;
046import java.util.List;
047import javax.enterprise.context.RequestScoped;
048
049@RequestScoped
050public class EditItemTaxClassificationCommand
051        extends BaseAbstractEditCommand<ItemTaxClassificationSpec, ItemTaxClassificationEdit, EditItemTaxClassificationResult, ItemTaxClassification, ItemTaxClassification> {
052
053    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
054    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
055    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
056
057    static {
058        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
059                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
060                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
061                        new SecurityRoleDefinition(SecurityRoleGroups.ItemTaxClassification.name(), SecurityRoles.Edit.name())
062                        )))
063                )));
064
065        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
066                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null)
068                ));
069
070        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
071                new FieldDefinition("TaxClassificationName", FieldType.ENTITY_NAME, true, null, null)
072                ));
073    }
074
075    /** Creates a new instance of EditItemTaxClassificationCommand */
076    public EditItemTaxClassificationCommand() {
077        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079
080    @Override
081    public EditItemTaxClassificationResult getResult() {
082        return TaxResultFactory.getEditItemTaxClassificationResult();
083    }
084
085    @Override
086    public ItemTaxClassificationEdit getEdit() {
087        return TaxEditFactory.getItemTaxClassificationEdit();
088    }
089
090    GeoCode countryGeoCode;
091
092    @Override
093    public ItemTaxClassification getEntity(EditItemTaxClassificationResult result) {
094        var itemControl = Session.getModelController(ItemControl.class);
095        ItemTaxClassification itemTaxClassification = null;
096        var itemName = spec.getItemName();
097        var item = itemControl.getItemByName(itemName);
098        
099        if(item != null) {
100            var geoControl = Session.getModelController(GeoControl.class);
101            var countryName = spec.getCountryName();
102            
103            countryGeoCode = geoControl.getCountryByAlias(countryName);
104            
105            if(countryGeoCode != null) {
106                var taxControl = Session.getModelController(TaxControl.class);
107                
108                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
109                    itemTaxClassification = taxControl.getItemTaxClassification(item, countryGeoCode);
110                } else { // EditMode.UPDATE
111                    itemTaxClassification = taxControl.getItemTaxClassificationForUpdate(item, countryGeoCode);
112                }
113
114                if(itemTaxClassification == null) {
115                    addExecutionError(ExecutionErrors.UnknownItemTaxClassification.name(), itemName, countryName);
116                }
117            } else {
118                addExecutionError(ExecutionErrors.UnknownCountryName.name(), countryName);
119            }
120        } else {
121            addExecutionError(ExecutionErrors.UnknownItemName.name(), itemName);
122        }
123
124        return itemTaxClassification;
125    }
126
127    @Override
128    public ItemTaxClassification getLockEntity(ItemTaxClassification itemTaxClassification) {
129        return itemTaxClassification;
130    }
131
132    @Override
133    public void fillInResult(EditItemTaxClassificationResult result, ItemTaxClassification itemTaxClassification) {
134        var taxControl = Session.getModelController(TaxControl.class);
135
136        result.setItemTaxClassification(taxControl.getItemTaxClassificationTransfer(getUserVisit(), itemTaxClassification));
137    }
138
139    @Override
140    public void doLock(ItemTaxClassificationEdit edit, ItemTaxClassification itemTaxClassification) {
141        var itemTaxClassificationDetail = itemTaxClassification.getLastDetail();
142        
143        edit.setTaxClassificationName(itemTaxClassificationDetail.getTaxClassification().getLastDetail().getTaxClassificationName());
144    }
145
146    TaxClassification harmonizedTariffScheduleCode;
147    
148    @Override
149    public void canUpdate(ItemTaxClassification itemTaxClassification) {
150        var taxControl = Session.getModelController(TaxControl.class);
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 taxControl = Session.getModelController(TaxControl.class);
163        var itemTaxClassificationDetailValue = taxControl.getItemTaxClassificationDetailValueForUpdate(itemTaxClassification);
164        
165        itemTaxClassificationDetailValue.setTaxClassificationPK(harmonizedTariffScheduleCode.getPrimaryKey());
166        
167        taxControl.updateItemTaxClassificationFromValue(itemTaxClassificationDetailValue, getPartyPK());
168    }
169
170}