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