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.GetHarmonizedTariffScheduleCodeUsesForm;
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.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class GetHarmonizedTariffScheduleCodeUsesCommand
041        extends BaseSimpleCommand<GetHarmonizedTariffScheduleCodeUsesForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.HarmonizedTariffScheduleCode.name(), SecurityRoles.HarmonizedTariffScheduleCodeUse.name())
051                        ))
052                ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("HarmonizedTariffScheduleCodeName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("HarmonizedTariffScheduleCodeUseTypeName", FieldType.ENTITY_NAME, false, null, null)
058                );
059    }
060    
061    /** Creates a new instance of GetHarmonizedTariffScheduleCodeUsesCommand */
062    public GetHarmonizedTariffScheduleCodeUsesCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var result = ItemResultFactory.getGetHarmonizedTariffScheduleCodeUsesResult();
069        var countryName = form.getCountryName();
070        var harmonizedTariffScheduleCodeName = form.getHarmonizedTariffScheduleCodeName();
071        var harmonizedTariffScheduleCodeUseTypeName = form.getHarmonizedTariffScheduleCodeUseTypeName();
072        var parameterCount = (countryName == null  && harmonizedTariffScheduleCodeName == null && harmonizedTariffScheduleCodeUseTypeName != null ? 0 : 1)
073                + (countryName != null  && harmonizedTariffScheduleCodeName != null && harmonizedTariffScheduleCodeUseTypeName == null ? 0 : 1);
074
075        if(parameterCount == 1) {
076            var itemControl = Session.getModelController(ItemControl.class);
077
078            if(harmonizedTariffScheduleCodeUseTypeName != null) {
079                var harmonizedTariffScheduleCodeUseType = itemControl.getHarmonizedTariffScheduleCodeUseTypeByName(harmonizedTariffScheduleCodeUseTypeName);
080
081                if(harmonizedTariffScheduleCodeUseType != null) {
082                    result.setHarmonizedTariffScheduleCodeUseType(itemControl.getHarmonizedTariffScheduleCodeUseTypeTransfer(getUserVisit(), harmonizedTariffScheduleCodeUseType));
083                    result.setHarmonizedTariffScheduleCodeUses(itemControl.getHarmonizedTariffScheduleCodeUseTransfersByHarmonizedTariffScheduleCodeUseType(getUserVisit(), harmonizedTariffScheduleCodeUseType));
084                } else {
085                    addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeUseTypeName.name(), harmonizedTariffScheduleCodeUseTypeName);
086                }
087            } else {
088                var geoControl = Session.getModelController(GeoControl.class);
089                var geoCode = geoControl.getCountryByAlias(countryName);
090
091                if(geoCode != null) {
092                    var harmonizedTariffScheduleCode = itemControl.getHarmonizedTariffScheduleCodeByName(geoCode, harmonizedTariffScheduleCodeName);
093
094                    if(harmonizedTariffScheduleCode != null) {
095                    result.setHarmonizedTariffScheduleCode(itemControl.getHarmonizedTariffScheduleCodeTransfer(getUserVisit(), harmonizedTariffScheduleCode));
096                    result.setHarmonizedTariffScheduleCodeUses(itemControl.getHarmonizedTariffScheduleCodeUseTransfersByHarmonizedTariffScheduleCode(getUserVisit(), harmonizedTariffScheduleCode));
097                    } else {
098                        addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeName.name(), countryName, harmonizedTariffScheduleCodeName);
099                    }
100                } else {
101                    addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), countryName);
102                }
103            }
104        } else {
105            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
106        }
107        
108        return result;
109    }
110    
111}