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