001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.carrier.server.command;
018
019import com.echothree.control.user.carrier.common.form.GetCarrierOptionDescriptionForm;
020import com.echothree.control.user.carrier.common.result.CarrierResultFactory;
021import com.echothree.model.control.carrier.server.control.CarrierControl;
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.Arrays;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class GetCarrierOptionDescriptionCommand
043        extends BaseSimpleCommand<GetCarrierOptionDescriptionForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.CarrierOption.name(), SecurityRoles.Description.name())
053                        )))
054                )));
055
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("CarrierOptionName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
060                ));
061    }
062    
063    /** Creates a new instance of GetCarrierOptionDescriptionCommand */
064    public GetCarrierOptionDescriptionCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var carrierControl = Session.getModelController(CarrierControl.class);
071        var result = CarrierResultFactory.getGetCarrierOptionDescriptionResult();
072        var carrierName = form.getCarrierName();
073        var carrier = carrierControl.getCarrierByName(carrierName);
074        
075        if(carrier != null) {
076            var carrierParty = carrier.getParty();
077            var carrierOptionName = form.getCarrierOptionName();
078            var carrierOption = carrierControl.getCarrierOptionByName(carrierParty, carrierOptionName);
079            
080            if(carrierOption != null) {
081                var partyControl = Session.getModelController(PartyControl.class);
082                var languageIsoName = form.getLanguageIsoName();
083                var language = partyControl.getLanguageByIsoName(languageIsoName);
084                
085                if(language != null) {
086                    var carrierOptionDescription = carrierControl.getCarrierOptionDescription(carrierOption, language);
087                    
088                    if(carrierOptionDescription != null) {
089                        result.setCarrierOptionDescription(carrierControl.getCarrierOptionDescriptionTransfer(getUserVisit(), carrierOptionDescription));
090                    } else {
091                        addExecutionError(ExecutionErrors.UnknownCarrierOptionDescription.name(), carrierName, carrierOptionName, languageIsoName);
092                    }
093                } else {
094                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
095                }
096            } else {
097                addExecutionError(ExecutionErrors.UnknownCarrierOptionName.name(), carrierName, carrierOptionName);
098            }
099        } else {
100            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
101        }
102        
103        return result;
104    }
105    
106}