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.GetHarmonizedTariffScheduleCodesForm;
020import com.echothree.control.user.item.common.result.ItemResultFactory;
021import com.echothree.model.control.geo.server.control.GeoControl;
022import com.echothree.model.control.item.server.control.ItemControl;
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.data.item.server.factory.HarmonizedTariffScheduleCodeFactory;
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 GetHarmonizedTariffScheduleCodesCommand
042        extends BaseSimpleCommand<GetHarmonizedTariffScheduleCodesForm> {
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.List.name())
052                    ))
053                ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null)
057                );
058    }
059    
060    /** Creates a new instance of GetHarmonizedTariffScheduleCodesCommand */
061    public GetHarmonizedTariffScheduleCodesCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var geoControl = Session.getModelController(GeoControl.class);
068        var result = ItemResultFactory.getGetHarmonizedTariffScheduleCodesResult();
069        var countryName = form.getCountryName();
070        var geoCode = geoControl.getCountryByAlias(countryName);
071        
072        if(geoCode != null) {
073            var itemControl = Session.getModelController(ItemControl.class);
074            
075            if(session.hasLimit(HarmonizedTariffScheduleCodeFactory.class)) {
076                result.setHarmonizedTariffScheduleCodeCount(itemControl.countHarmonizedTariffScheduleCodesByCountryGeoCode(geoCode));
077            }
078            
079            result.setCountry(geoControl.getCountryTransfer(getUserVisit(), geoCode));
080            result.setHarmonizedTariffScheduleCodes(itemControl.getHarmonizedTariffScheduleCodeTransfersByCountryGeoCode(getUserVisit(), geoCode));
081        } else {
082            addExecutionError(ExecutionErrors.UnknownCountryName.name(), countryName);
083        }
084        
085        return result;
086    }
087    
088}