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.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.HarmonizedTariffScheduleCode;
028import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCodeUse;
029import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCodeUseType;
030import com.echothree.model.data.item.server.factory.HarmonizedTariffScheduleCodeUseFactory;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import java.util.Collection;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042import javax.inject.Inject;
043
044@Dependent
045public class GetHarmonizedTariffScheduleCodeUsesCommand
046        extends BasePaginatedMultipleEntitiesCommand<HarmonizedTariffScheduleCodeUse, GetHarmonizedTariffScheduleCodeUsesForm> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.HarmonizedTariffScheduleCode.name(), SecurityRoles.HarmonizedTariffScheduleCodeUse.name())
056                ))
057        ));
058
059        FORM_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, false, null, null),
061                new FieldDefinition("HarmonizedTariffScheduleCodeName", FieldType.ENTITY_NAME, false, null, null),
062                new FieldDefinition("HarmonizedTariffScheduleCodeUseTypeName", FieldType.ENTITY_NAME, false, null, null)
063        );
064    }
065    
066    @Inject
067    GeoControl geoControl;
068
069    @Inject
070    ItemControl itemControl;
071
072    @Inject
073    HarmonizedTariffScheduleCodeLogic harmonizedTariffScheduleCodeLogic;
074
075    /** Creates a new instance of GetHarmonizedTariffScheduleCodeUsesCommand */
076    public GetHarmonizedTariffScheduleCodeUsesCommand() {
077        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
078    }
079
080    private HarmonizedTariffScheduleCode harmonizedTariffScheduleCode;
081    private HarmonizedTariffScheduleCodeUseType harmonizedTariffScheduleCodeUseType;
082
083    @Override
084    protected void handleForm() {
085        var countryName = form.getCountryName();
086        var harmonizedTariffScheduleCodeName = form.getHarmonizedTariffScheduleCodeName();
087        var harmonizedTariffScheduleCodeUseTypeName = form.getHarmonizedTariffScheduleCodeUseTypeName();
088        var parameterCount = (countryName == null && harmonizedTariffScheduleCodeName == null && harmonizedTariffScheduleCodeUseTypeName != null ? 0 : 1)
089                + (countryName != null  && harmonizedTariffScheduleCodeName != null && harmonizedTariffScheduleCodeUseTypeName == null ? 0 : 1);
090
091        if(parameterCount == 1) {
092            if(harmonizedTariffScheduleCodeUseTypeName != null) {
093                harmonizedTariffScheduleCodeUseType = harmonizedTariffScheduleCodeLogic.getHarmonizedTariffScheduleCodeUseTypeByName(this, harmonizedTariffScheduleCodeUseTypeName);
094            } else {
095                var geoCode = geoControl.getCountryByAlias(countryName);
096
097                if(geoCode != null) {
098                    harmonizedTariffScheduleCode = itemControl.getHarmonizedTariffScheduleCodeByName(geoCode, harmonizedTariffScheduleCodeName);
099
100                    if(harmonizedTariffScheduleCode == null) {
101                        addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeName.name(), countryName, harmonizedTariffScheduleCodeName);
102                    }
103                } else {
104                    addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), countryName);
105                }
106            }
107        } else {
108            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
109        }
110    }
111
112    @Override
113    protected Long getTotalEntities() {
114        Long total = null;
115
116        if(!hasExecutionErrors()) {
117            if(harmonizedTariffScheduleCode != null) {
118                total = itemControl.countHarmonizedTariffScheduleCodeUsesByHarmonizedTariffScheduleCode(harmonizedTariffScheduleCode);
119            } else {
120                total = itemControl.countHarmonizedTariffScheduleCodeUsesByHarmonizedTariffScheduleCodeUseType(harmonizedTariffScheduleCodeUseType);
121            }
122        }
123
124        return total;
125    }
126
127    @Override
128    protected Collection<HarmonizedTariffScheduleCodeUse> getEntities() {
129        Collection<HarmonizedTariffScheduleCodeUse> entities = null;
130
131        if(!hasExecutionErrors()) {
132            if(harmonizedTariffScheduleCode != null) {
133                entities = itemControl.getHarmonizedTariffScheduleCodeUsesByHarmonizedTariffScheduleCode(harmonizedTariffScheduleCode);
134            } else {
135                entities = itemControl.getHarmonizedTariffScheduleCodeUsesByHarmonizedTariffScheduleCodeUseType(harmonizedTariffScheduleCodeUseType);
136            }
137        }
138
139        return entities;
140    }
141
142    @Override
143    protected BaseResult getResult(Collection<HarmonizedTariffScheduleCodeUse> entities) {
144        var result = ItemResultFactory.getGetHarmonizedTariffScheduleCodeUsesResult();
145
146        if(entities != null) {
147            if(harmonizedTariffScheduleCode != null) {
148                result.setHarmonizedTariffScheduleCode(itemControl.getHarmonizedTariffScheduleCodeTransfer(getUserVisit(), harmonizedTariffScheduleCode));
149            } else {
150                result.setHarmonizedTariffScheduleCodeUseType(itemControl.getHarmonizedTariffScheduleCodeUseTypeTransfer(getUserVisit(), harmonizedTariffScheduleCodeUseType));
151            }
152
153            if(session.hasLimit(HarmonizedTariffScheduleCodeUseFactory.class)) {
154                result.setHarmonizedTariffScheduleCodeUseCount(getTotalEntities());
155            }
156
157            result.setHarmonizedTariffScheduleCodeUses(itemControl.getHarmonizedTariffScheduleCodeUseTransfers(getUserVisit(), entities));
158        }
159
160        return result;
161    }
162    
163}