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.GetHarmonizedTariffScheduleCodeUnitDescriptionForm;
020import com.echothree.control.user.item.common.result.ItemResultFactory;
021import com.echothree.model.control.item.server.control.ItemControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.party.server.control.PartyControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class GetHarmonizedTariffScheduleCodeUnitDescriptionCommand
041        extends BaseSimpleCommand<GetHarmonizedTariffScheduleCodeUnitDescriptionForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.HarmonizedTariffScheduleCodeUnit.name(), SecurityRoles.Description.name())
051                        ))
052                ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("HarmonizedTariffScheduleCodeUnitName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
057                );
058    }
059    
060    /** Creates a new instance of GetHarmonizedTariffScheduleCodeUnitDescriptionCommand */
061    public GetHarmonizedTariffScheduleCodeUnitDescriptionCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var itemControl = Session.getModelController(ItemControl.class);
068        var result = ItemResultFactory.getGetHarmonizedTariffScheduleCodeUnitDescriptionResult();
069        var harmonizedTariffScheduleCodeUnitName = form.getHarmonizedTariffScheduleCodeUnitName();
070        var harmonizedTariffScheduleCodeUnit = itemControl.getHarmonizedTariffScheduleCodeUnitByName(harmonizedTariffScheduleCodeUnitName);
071        
072        if(harmonizedTariffScheduleCodeUnit != null) {
073            var partyControl = Session.getModelController(PartyControl.class);
074            var languageIsoName = form.getLanguageIsoName();
075            var language = partyControl.getLanguageByIsoName(languageIsoName);
076            
077            if(language != null) {
078                var harmonizedTariffScheduleCodeUnitDescription = itemControl.getHarmonizedTariffScheduleCodeUnitDescription(harmonizedTariffScheduleCodeUnit, language);
079                
080                if(harmonizedTariffScheduleCodeUnitDescription != null) {
081                    result.setHarmonizedTariffScheduleCodeUnitDescription(itemControl.getHarmonizedTariffScheduleCodeUnitDescriptionTransfer(getUserVisit(), harmonizedTariffScheduleCodeUnitDescription));
082                } else {
083                    addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeUnitDescription.name(), harmonizedTariffScheduleCodeUnitName, languageIsoName);
084                }
085            } else {
086                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
087            }
088        } else {
089            addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeUnitName.name(), harmonizedTariffScheduleCodeUnitName);
090        }
091        
092        return result;
093    }
094    
095}