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.GetItemHarmonizedTariffScheduleCodeForm;
020import com.echothree.control.user.item.common.result.GetItemHarmonizedTariffScheduleCodeResult;
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.item.server.entity.ItemHarmonizedTariffScheduleCode;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
036import com.echothree.util.server.control.BaseSimpleCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class GetItemHarmonizedTariffScheduleCodeCommand
046        extends BaseSimpleCommand<GetItemHarmonizedTariffScheduleCodeForm> {
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(Collections.unmodifiableList(Arrays.asList(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
055                    new SecurityRoleDefinition(SecurityRoleGroups.ItemHarmonizedTariffScheduleCode.name(), SecurityRoles.Review.name())
056                    )))
057                )));
058
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("HarmonizedTariffScheduleCodeUseTypeName", FieldType.ENTITY_NAME, true, null, null)
063                ));
064    }
065    
066    /** Creates a new instance of GetItemHarmonizedTariffScheduleCodeCommand */
067    public GetItemHarmonizedTariffScheduleCodeCommand(UserVisitPK userVisitPK, GetItemHarmonizedTariffScheduleCodeForm form) {
068        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        var itemControl = Session.getModelController(ItemControl.class);
074        GetItemHarmonizedTariffScheduleCodeResult result = ItemResultFactory.getGetItemHarmonizedTariffScheduleCodeResult();
075        String itemName = form.getItemName();
076        Item item = itemControl.getItemByName(itemName);
077        
078        if(item != null) {
079            var geoControl = Session.getModelController(GeoControl.class);
080            String countryName = form.getCountryName();
081            GeoCode countryGeoCode = geoControl.getCountryByAlias(countryName);
082            
083            if(countryGeoCode != null) {
084                String harmonizedTariffScheduleCodeUseTypeName = form.getHarmonizedTariffScheduleCodeUseTypeName();
085                HarmonizedTariffScheduleCodeUseType harmonizedTariffScheduleCodeUseType = itemControl.getHarmonizedTariffScheduleCodeUseTypeByName(harmonizedTariffScheduleCodeUseTypeName);
086
087                if(harmonizedTariffScheduleCodeUseType != null) {
088                    ItemHarmonizedTariffScheduleCode itemHarmonizedTariffScheduleCode = itemControl.getItemHarmonizedTariffScheduleCode(item, countryGeoCode,
089                            harmonizedTariffScheduleCodeUseType);
090
091                    if(itemHarmonizedTariffScheduleCode != null) {
092                        result.setItemHarmonizedTariffScheduleCode(itemControl.getItemHarmonizedTariffScheduleCodeTransfer(getUserVisit(), itemHarmonizedTariffScheduleCode));
093                    } else {
094                        addExecutionError(ExecutionErrors.UnknownItemHarmonizedTariffScheduleCode.name(), itemName, countryName, harmonizedTariffScheduleCodeUseTypeName);
095                    }
096                } else {
097                    addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeUseTypeName.name(), harmonizedTariffScheduleCodeUseTypeName);
098                }
099            } else {
100                addExecutionError(ExecutionErrors.UnknownCountryName.name(), countryName);
101            }
102        } else {
103            addExecutionError(ExecutionErrors.UnknownItemName.name(), itemName);
104        }
105        
106        return result;
107    }
108    
109}