001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.item.server.entity.Item;
033import com.echothree.model.data.tax.server.entity.ItemTaxClassification;
034import com.echothree.model.data.tax.server.entity.ItemTaxClassificationDetail;
035import com.echothree.model.data.tax.server.entity.TaxClassification;
036import com.echothree.model.data.tax.server.value.ItemTaxClassificationDetailValue;
037import com.echothree.model.data.user.common.pk.UserVisitPK;
038import com.echothree.util.common.message.ExecutionErrors;
039import com.echothree.util.common.validation.FieldDefinition;
040import com.echothree.util.common.validation.FieldType;
041import com.echothree.util.common.command.EditMode;
042import com.echothree.util.server.control.BaseAbstractEditCommand;
043import com.echothree.util.server.control.CommandSecurityDefinition;
044import com.echothree.util.server.control.PartyTypeDefinition;
045import com.echothree.util.server.control.SecurityRoleDefinition;
046import com.echothree.util.server.persistence.Session;
047import java.util.Arrays;
048import java.util.Collections;
049import java.util.List;
050
051public class EditItemTaxClassificationCommand
052        extends BaseAbstractEditCommand<ItemTaxClassificationSpec, ItemTaxClassificationEdit, EditItemTaxClassificationResult, ItemTaxClassification, ItemTaxClassification> {
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(Collections.unmodifiableList(Arrays.asList(
060                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
061                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
062                        new SecurityRoleDefinition(SecurityRoleGroups.ItemTaxClassification.name(), SecurityRoles.Edit.name())
063                        )))
064                )));
065
066        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
067                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
068                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null)
069                ));
070
071        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
072                new FieldDefinition("TaxClassificationName", FieldType.ENTITY_NAME, true, null, null)
073                ));
074    }
075
076    /** Creates a new instance of EditItemTaxClassificationCommand */
077    public EditItemTaxClassificationCommand(UserVisitPK userVisitPK, EditItemTaxClassificationForm form) {
078        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
079    }
080
081    @Override
082    public EditItemTaxClassificationResult getResult() {
083        return TaxResultFactory.getEditItemTaxClassificationResult();
084    }
085
086    @Override
087    public ItemTaxClassificationEdit getEdit() {
088        return TaxEditFactory.getItemTaxClassificationEdit();
089    }
090
091    GeoCode countryGeoCode;
092
093    @Override
094    public ItemTaxClassification getEntity(EditItemTaxClassificationResult result) {
095        var itemControl = Session.getModelController(ItemControl.class);
096        ItemTaxClassification itemTaxClassification = null;
097        String itemName = spec.getItemName();
098        Item item = itemControl.getItemByName(itemName);
099        
100        if(item != null) {
101            var geoControl = Session.getModelController(GeoControl.class);
102            String countryName = spec.getCountryName();
103            
104            countryGeoCode = geoControl.getCountryByAlias(countryName);
105            
106            if(countryGeoCode != null) {
107                var taxControl = Session.getModelController(TaxControl.class);
108                
109                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
110                    itemTaxClassification = taxControl.getItemTaxClassification(item, countryGeoCode);
111                } else { // EditMode.UPDATE
112                    itemTaxClassification = taxControl.getItemTaxClassificationForUpdate(item, countryGeoCode);
113                }
114
115                if(itemTaxClassification == null) {
116                    addExecutionError(ExecutionErrors.UnknownItemTaxClassification.name(), itemName, countryName);
117                }
118            } else {
119                addExecutionError(ExecutionErrors.UnknownCountryName.name(), countryName);
120            }
121        } else {
122            addExecutionError(ExecutionErrors.UnknownItemName.name(), itemName);
123        }
124
125        return itemTaxClassification;
126    }
127
128    @Override
129    public ItemTaxClassification getLockEntity(ItemTaxClassification itemTaxClassification) {
130        return itemTaxClassification;
131    }
132
133    @Override
134    public void fillInResult(EditItemTaxClassificationResult result, ItemTaxClassification itemTaxClassification) {
135        var taxControl = Session.getModelController(TaxControl.class);
136
137        result.setItemTaxClassification(taxControl.getItemTaxClassificationTransfer(getUserVisit(), itemTaxClassification));
138    }
139
140    @Override
141    public void doLock(ItemTaxClassificationEdit edit, ItemTaxClassification itemTaxClassification) {
142        ItemTaxClassificationDetail 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 taxControl = Session.getModelController(TaxControl.class);
152        String harmonizedTariffScheduleCodeName = edit.getTaxClassificationName();
153        
154        harmonizedTariffScheduleCode = taxControl.getTaxClassificationByName(countryGeoCode, harmonizedTariffScheduleCodeName);
155
156        if(harmonizedTariffScheduleCode == null) {
157            addExecutionError(ExecutionErrors.UnknownTaxClassificationName.name(), spec.getCountryName(), harmonizedTariffScheduleCodeName);
158        }
159    }
160
161    @Override
162    public void doUpdate(ItemTaxClassification itemTaxClassification) {
163        var taxControl = Session.getModelController(TaxControl.class);
164        ItemTaxClassificationDetailValue itemTaxClassificationDetailValue = taxControl.getItemTaxClassificationDetailValueForUpdate(itemTaxClassification);
165        
166        itemTaxClassificationDetailValue.setTaxClassificationPK(harmonizedTariffScheduleCode.getPrimaryKey());
167        
168        taxControl.updateItemTaxClassificationFromValue(itemTaxClassificationDetailValue, getPartyPK());
169    }
170
171}