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.GetHarmonizedTariffScheduleCodeUseForm;
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.item.server.logic.HarmonizedTariffScheduleCodeLogic;
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.item.server.entity.HarmonizedTariffScheduleCodeUse;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSingleEntityCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetHarmonizedTariffScheduleCodeUseCommand
042        extends BaseSingleEntityCommand<HarmonizedTariffScheduleCodeUse, GetHarmonizedTariffScheduleCodeUseForm> {
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.HarmonizedTariffScheduleCodeUse.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.ENTITY_NAME, true, null, null),
058                new FieldDefinition("HarmonizedTariffScheduleCodeUseTypeName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061
062    @Inject
063    GeoControl geoControl;
064
065    @Inject
066    ItemControl itemControl;
067
068    @Inject
069    HarmonizedTariffScheduleCodeLogic harmonizedTariffScheduleCodeLogic;
070
071    /** Creates a new instance of GetHarmonizedTariffScheduleCodeUseCommand */
072    public GetHarmonizedTariffScheduleCodeUseCommand() {
073        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
074    }
075    
076    @Override
077    protected HarmonizedTariffScheduleCodeUse getEntity() {
078        HarmonizedTariffScheduleCodeUse harmonizedTariffScheduleCodeUse = null;
079        var countryName = form.getCountryName();
080        var geoCode = geoControl.getCountryByAlias(countryName);
081
082        if(geoCode != null) {
083            var harmonizedTariffScheduleCodeName = form.getHarmonizedTariffScheduleCodeName();
084            var harmonizedTariffScheduleCode = itemControl.getHarmonizedTariffScheduleCodeByName(geoCode, harmonizedTariffScheduleCodeName);
085
086            if(harmonizedTariffScheduleCode != null) {
087                var harmonizedTariffScheduleCodeUseTypeName = form.getHarmonizedTariffScheduleCodeUseTypeName();
088                var harmonizedTariffScheduleCodeUseType = harmonizedTariffScheduleCodeLogic.getHarmonizedTariffScheduleCodeUseTypeByName(this, harmonizedTariffScheduleCodeUseTypeName);
089
090                if(!hasExecutionErrors()) {
091                    harmonizedTariffScheduleCodeUse = itemControl.getHarmonizedTariffScheduleCodeUse(harmonizedTariffScheduleCode, harmonizedTariffScheduleCodeUseType);
092
093                    if(harmonizedTariffScheduleCodeUse == null) {
094                        addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeUse.name(), countryName, harmonizedTariffScheduleCodeName, harmonizedTariffScheduleCodeUseTypeName);
095                    }
096                }
097            } else {
098                addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeName.name(), countryName, harmonizedTariffScheduleCodeName);
099            }
100        } else {
101            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), countryName);
102        }
103
104        return harmonizedTariffScheduleCodeUse;
105    }
106
107    @Override
108    protected BaseResult getResult(HarmonizedTariffScheduleCodeUse harmonizedTariffScheduleCodeUse) {
109        var result = ItemResultFactory.getGetHarmonizedTariffScheduleCodeUseResult();
110
111        if(harmonizedTariffScheduleCodeUse != null) {
112            result.setHarmonizedTariffScheduleCodeUse(itemControl.getHarmonizedTariffScheduleCodeUseTransfer(getUserVisit(), harmonizedTariffScheduleCodeUse));
113        }
114
115        return result;
116    }
117    
118}