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.form.CreateItemTaxClassificationForm;
020import com.echothree.model.control.geo.server.control.GeoControl;
021import com.echothree.model.control.item.server.control.ItemControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.control.tax.server.control.TaxControl;
026import com.echothree.model.data.geo.server.entity.GeoCode;
027import com.echothree.model.data.item.server.entity.Item;
028import com.echothree.model.data.tax.server.entity.ItemTaxClassification;
029import com.echothree.model.data.tax.server.entity.TaxClassification;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043
044public class CreateItemTaxClassificationCommand
045        extends BaseSimpleCommand<CreateItemTaxClassificationForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                    new SecurityRoleDefinition(SecurityRoleGroups.ItemTaxClassification.name(), SecurityRoles.Create.name())
055                    )))
056                )));
057
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("TaxClassificationName", FieldType.ENTITY_NAME, true, null, null)
062                ));
063    }
064    
065    /** Creates a new instance of CreateItemTaxClassificationCommand */
066    public CreateItemTaxClassificationCommand(UserVisitPK userVisitPK, CreateItemTaxClassificationForm form) {
067        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        var itemControl = Session.getModelController(ItemControl.class);
073        String itemName = form.getItemName();
074        Item item = itemControl.getItemByName(itemName);
075        
076        if(item != null) {
077            var geoControl = Session.getModelController(GeoControl.class);
078            String countryName = form.getCountryName();
079            GeoCode countryGeoCode = geoControl.getCountryByAlias(countryName);
080            
081            if(countryGeoCode != null) {
082                var taxControl = Session.getModelController(TaxControl.class);
083                ItemTaxClassification itemTaxClassification = taxControl.getItemTaxClassification(item, countryGeoCode);
084
085                if(itemTaxClassification == null) {
086                    String harmonizedTariffScheduleCodeName = form.getTaxClassificationName();
087                    TaxClassification harmonizedTariffScheduleCode = taxControl.getTaxClassificationByName(countryGeoCode, harmonizedTariffScheduleCodeName);
088
089                    if(harmonizedTariffScheduleCode != null) {
090                            taxControl.createItemTaxClassification(item, countryGeoCode, harmonizedTariffScheduleCode, getPartyPK());
091                    } else {
092                        addExecutionError(ExecutionErrors.UnknownTaxClassificationName.name(), harmonizedTariffScheduleCodeName);
093                    }
094                } else {
095                    addExecutionError(ExecutionErrors.DuplicateItemTaxClassification.name(), itemName, countryName);
096                }
097            } else {
098                addExecutionError(ExecutionErrors.UnknownCountryName.name(), countryName);
099            }
100        } else {
101            addExecutionError(ExecutionErrors.UnknownItemName.name(), itemName);
102        }
103        
104        return null;
105    }
106    
107}