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.item.server.command;
018
019import com.echothree.control.user.item.common.form.GetItemHarmonizedTariffScheduleCodeForm;
020import com.echothree.control.user.item.common.result.ItemResultFactory;
021import com.echothree.model.control.geo.server.control.GeoControl;
022import com.echothree.model.control.geo.server.logic.GeoCodeLogic;
023import com.echothree.model.control.item.server.control.ItemControl;
024import com.echothree.model.control.item.server.logic.HarmonizedTariffScheduleCodeLogic;
025import com.echothree.model.control.item.server.logic.ItemLogic;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetItemHarmonizedTariffScheduleCodeCommand
043        extends BaseSimpleCommand<GetItemHarmonizedTariffScheduleCodeForm> {
044
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.ItemHarmonizedTariffScheduleCode.name(), SecurityRoles.Review.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("HarmonizedTariffScheduleCodeUseTypeName", FieldType.ENTITY_NAME, true, null, null)
060        );
061    }
062
063    @Inject
064    GeoControl geoControl;
065
066    @Inject
067    ItemControl itemControl;
068
069    @Inject
070    GeoCodeLogic geoCodeLogic;
071
072    @Inject
073    HarmonizedTariffScheduleCodeLogic harmonizedTariffScheduleCodeLogic;
074
075    @Inject
076    ItemLogic itemLogic;
077
078    /** Creates a new instance of GetItemHarmonizedTariffScheduleCodeCommand */
079    public GetItemHarmonizedTariffScheduleCodeCommand() {
080        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
081    }
082    
083    @Override
084    protected BaseResult execute() {
085        var result = ItemResultFactory.getGetItemHarmonizedTariffScheduleCodeResult();
086        var itemName = form.getItemName();
087        var item = itemLogic.getItemByName(this, itemName);
088
089        if(item != null) {
090            var countryName = form.getCountryName();
091            var countryGeoCode = geoCodeLogic.getGeoCodeByAlias(this, geoControl.getGeoCodeTypeByName("COUNTRY"), geoControl.getGeoCodeScopeByName("UTILITY"), "ISO_2_LETTER", countryName);
092
093            if(countryGeoCode != null) {
094                var harmonizedTariffScheduleCodeUseTypeName = form.getHarmonizedTariffScheduleCodeUseTypeName();
095                var harmonizedTariffScheduleCodeUseType = harmonizedTariffScheduleCodeLogic.getHarmonizedTariffScheduleCodeUseTypeByName(this, harmonizedTariffScheduleCodeUseTypeName);
096
097                if(harmonizedTariffScheduleCodeUseType != null) {
098                    var itemHarmonizedTariffScheduleCode = itemControl.getItemHarmonizedTariffScheduleCode(item, countryGeoCode,
099                            harmonizedTariffScheduleCodeUseType);
100
101                    if(itemHarmonizedTariffScheduleCode != null) {
102                        result.setItemHarmonizedTariffScheduleCode(itemControl.getItemHarmonizedTariffScheduleCodeTransfer(getUserVisit(), itemHarmonizedTariffScheduleCode));
103                    } else {
104                        addExecutionError(ExecutionErrors.UnknownItemHarmonizedTariffScheduleCode.name(), itemName, countryName, harmonizedTariffScheduleCodeUseTypeName);
105                    }
106                }
107            }
108        }
109
110        return result;
111    }
112    
113}