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.GetItemHarmonizedTariffScheduleCodesForm;
020import com.echothree.control.user.item.common.result.GetItemHarmonizedTariffScheduleCodesResult;
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.entity.HarmonizedTariffScheduleCodeUseType;
029import com.echothree.model.data.item.server.entity.Item;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043
044public class GetItemHarmonizedTariffScheduleCodesCommand
045        extends BaseSimpleCommand<GetItemHarmonizedTariffScheduleCodesForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                    new SecurityRoleDefinition(SecurityRoleGroups.ItemHarmonizedTariffScheduleCode.name(), SecurityRoles.List.name())
055                    )))
056                )));
057
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, false, null, null),
060                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, false, null, null),
061                new FieldDefinition("HarmonizedTariffScheduleCodeUseTypeName", FieldType.ENTITY_NAME, false, null, null)
062                ));
063    }
064    
065    /** Creates a new instance of GetItemHarmonizedTariffScheduleCodesCommand */
066    public GetItemHarmonizedTariffScheduleCodesCommand(UserVisitPK userVisitPK, GetItemHarmonizedTariffScheduleCodesForm form) {
067        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        GetItemHarmonizedTariffScheduleCodesResult result = ItemResultFactory.getGetItemHarmonizedTariffScheduleCodesResult();
073        String itemName = form.getItemName();
074        String countryName = form.getCountryName();
075        String harmonizedTariffScheduleCodeUseTypeName = form.getHarmonizedTariffScheduleCodeUseTypeName();
076        var parameterCount = (itemName == null ? 0 : 1) + (countryName == null ? 0 : 1) + (harmonizedTariffScheduleCodeUseTypeName == null ? 0 : 1);
077
078        if(parameterCount == 1) {
079            var itemControl = Session.getModelController(ItemControl.class);
080
081            if(itemName != null) {
082                Item item = itemControl.getItemByName(itemName);
083
084                if(item != null) {
085                    result.setItem(itemControl.getItemTransfer(getUserVisit(), item));
086                    result.setItemHarmonizedTariffScheduleCodes(itemControl.getItemHarmonizedTariffScheduleCodeTransfersByItem(getUserVisit(), item));
087                } else {
088                    addExecutionError(ExecutionErrors.UnknownItemName.name(), itemName);
089                }
090            } else if(countryName != null) {
091                var geoControl = Session.getModelController(GeoControl.class);
092                GeoCode countryGeoCode = geoControl.getCountryByAlias(countryName);
093
094                if(countryGeoCode != null) {
095                    result.setCountry(geoControl.getCountryTransfer(getUserVisit(), countryGeoCode));
096                    result.setItemHarmonizedTariffScheduleCodes(itemControl.getItemHarmonizedTariffScheduleCodeTransfersByCountryGeoCode(getUserVisit(), countryGeoCode));
097                } else {
098                    addExecutionError(ExecutionErrors.UnknownCountryName.name(), countryName);
099                }
100            } else {
101                HarmonizedTariffScheduleCodeUseType harmonizedTariffScheduleCodeUseType = itemControl.getHarmonizedTariffScheduleCodeUseTypeByName(harmonizedTariffScheduleCodeUseTypeName);
102
103                if(harmonizedTariffScheduleCodeUseType != null) {
104                    result.setHarmonizedTariffScheduleCodeUseType(itemControl.getHarmonizedTariffScheduleCodeUseTypeTransfer(getUserVisit(), harmonizedTariffScheduleCodeUseType));
105                    result.setItemHarmonizedTariffScheduleCodes(itemControl.getItemHarmonizedTariffScheduleCodeTransfersByHarmonizedTariffScheduleCodeUseType(getUserVisit(), harmonizedTariffScheduleCodeUseType));
106                } else {
107                    addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeUseTypeName.name(), harmonizedTariffScheduleCodeUseTypeName);
108                }
109            }
110        } else {
111            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
112        }
113
114        return result;
115    }
116    
117}