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