001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.GetHarmonizedTariffScheduleCodesResult;
021import com.echothree.control.user.item.common.result.ItemResultFactory;
022import com.echothree.model.control.geo.server.control.GeoControl;
023import com.echothree.model.control.item.server.control.ItemControl;
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.geo.server.entity.GeoCode;
028import com.echothree.model.data.item.server.factory.HarmonizedTariffScheduleCodeFactory;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
034import com.echothree.util.server.control.BaseSimpleCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import com.echothree.util.server.persistence.Session;
039import java.util.Arrays;
040import java.util.Collections;
041import java.util.List;
042
043public class GetHarmonizedTariffScheduleCodesCommand
044        extends BaseSimpleCommand<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(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                    new SecurityRoleDefinition(SecurityRoleGroups.HarmonizedTariffScheduleCode.name(), SecurityRoles.List.name())
054                    )))
055                )));
056
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of GetHarmonizedTariffScheduleCodesCommand */
063    public GetHarmonizedTariffScheduleCodesCommand(UserVisitPK userVisitPK, GetHarmonizedTariffScheduleCodesForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var geoControl = Session.getModelController(GeoControl.class);
070        GetHarmonizedTariffScheduleCodesResult result = ItemResultFactory.getGetHarmonizedTariffScheduleCodesResult();
071        String countryName = form.getCountryName();
072        GeoCode geoCode = geoControl.getCountryByAlias(countryName);
073        
074        if(geoCode != null) {
075            var itemControl = Session.getModelController(ItemControl.class);
076            
077            if(session.hasLimit(HarmonizedTariffScheduleCodeFactory.class)) {
078                result.setHarmonizedTariffScheduleCodeCount(itemControl.countHarmonizedTariffScheduleCodesByCountryGeoCode(geoCode));
079            }
080            
081            result.setCountry(geoControl.getCountryTransfer(getUserVisit(), geoCode));
082            result.setHarmonizedTariffScheduleCodes(itemControl.getHarmonizedTariffScheduleCodeTransfersByCountryGeoCode(getUserVisit(), geoCode));
083        } else {
084            addExecutionError(ExecutionErrors.UnknownCountryName.name(), countryName);
085        }
086        
087        return result;
088    }
089    
090}