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