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.GetHarmonizedTariffScheduleCodeForm;
020import com.echothree.control.user.item.common.result.ItemResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
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.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039
040@Dependent
041public class GetHarmonizedTariffScheduleCodeCommand
042        extends BaseSimpleCommand<GetHarmonizedTariffScheduleCodeForm> {
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.HarmonizedTariffScheduleCode.name(), SecurityRoles.Review.name())
052                    ))
053                ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("HarmonizedTariffScheduleCodeName", FieldType.HARMONIZED_TARIFF_SCHEDULE_CODE, true, null, null)
058                );
059    }
060    
061    /** Creates a new instance of GetHarmonizedTariffScheduleCodeCommand */
062    public GetHarmonizedTariffScheduleCodeCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var geoControl = Session.getModelController(GeoControl.class);
069        var result = ItemResultFactory.getGetHarmonizedTariffScheduleCodeResult();
070        var countryName = form.getCountryName();
071        var geoCode = geoControl.getCountryByAlias(countryName);
072        
073        if(geoCode != null) {
074            var itemControl = Session.getModelController(ItemControl.class);
075            var harmonizedTariffScheduleCodeName = form.getHarmonizedTariffScheduleCodeName();
076            var harmonizedTariffScheduleCode = itemControl.getHarmonizedTariffScheduleCodeByName(geoCode, harmonizedTariffScheduleCodeName);
077            
078            if(harmonizedTariffScheduleCode != null) {
079                result.setHarmonizedTariffScheduleCode(itemControl.getHarmonizedTariffScheduleCodeTransfer(getUserVisit(), harmonizedTariffScheduleCode));
080                
081                sendEvent(harmonizedTariffScheduleCode.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
082            } else {
083                addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeName.name(), countryName, harmonizedTariffScheduleCodeName);
084            }
085        } else {
086            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), countryName);
087        }
088        
089        return result;
090    }
091    
092}