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.geo.server.entity.GeoCode;
027import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCode;
028import com.echothree.model.data.item.server.factory.HarmonizedTariffScheduleCodeFactory;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.Collection;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
041
042@Dependent
043public class GetHarmonizedTariffScheduleCodesCommand
044        extends BasePaginatedMultipleEntitiesCommand<HarmonizedTariffScheduleCode, GetHarmonizedTariffScheduleCodesForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.HarmonizedTariffScheduleCode.name(), SecurityRoles.List.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061
062    @Inject
063    GeoControl geoControl;
064
065    @Inject
066    ItemControl itemControl;
067
068    private GeoCode countryGeoCode;
069
070    /** Creates a new instance of GetHarmonizedTariffScheduleCodesCommand */
071    public GetHarmonizedTariffScheduleCodesCommand() {
072        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
073    }
074
075    @Override
076    protected void handleForm() {
077        var countryName = form.getCountryName();
078
079        countryGeoCode = geoControl.getCountryByAlias(countryName);
080
081        if(countryGeoCode == null) {
082            addExecutionError(ExecutionErrors.UnknownCountryName.name(), countryName);
083        }
084    }
085
086    @Override
087    protected Long getTotalEntities() {
088        return countryGeoCode == null ? null : itemControl.countHarmonizedTariffScheduleCodesByCountryGeoCode(countryGeoCode);
089    }
090
091    @Override
092    protected Collection<HarmonizedTariffScheduleCode> getEntities() {
093        return countryGeoCode == null ? null : itemControl.getHarmonizedTariffScheduleCodesByCountryGeoCode(countryGeoCode);
094    }
095
096    @Override
097    protected BaseResult getResult(Collection<HarmonizedTariffScheduleCode> entities) {
098        var result = ItemResultFactory.getGetHarmonizedTariffScheduleCodesResult();
099
100        if(entities != null) {
101            result.setCountry(geoControl.getCountryTransfer(getUserVisit(), countryGeoCode));
102
103            if(session.hasLimit(HarmonizedTariffScheduleCodeFactory.class)) {
104                result.setHarmonizedTariffScheduleCodeCount(getTotalEntities());
105            }
106
107            result.setHarmonizedTariffScheduleCodes(itemControl.getHarmonizedTariffScheduleCodeTransfers(getUserVisit(), entities));
108        }
109
110        return result;
111    }
112    
113}