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.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.control.user.carrier.common.result.GetCarrierOptionDescriptionResult;
022import com.echothree.model.control.carrier.server.control.CarrierControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.party.server.control.PartyControl;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.carrier.server.entity.Carrier;
028import com.echothree.model.data.carrier.server.entity.CarrierOption;
029import com.echothree.model.data.carrier.server.entity.CarrierOptionDescription;
030import com.echothree.model.data.party.server.entity.Language;
031import com.echothree.model.data.party.server.entity.Party;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.common.command.BaseResult;
037import com.echothree.util.server.control.BaseSimpleCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import com.echothree.util.server.persistence.Session;
042import java.util.Arrays;
043import java.util.Collections;
044import java.util.List;
045
046public class GetCarrierOptionDescriptionCommand
047        extends BaseSimpleCommand<GetCarrierOptionDescriptionForm> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
051    
052    static {
053        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
056                        new SecurityRoleDefinition(SecurityRoleGroups.CarrierOption.name(), SecurityRoles.Description.name())
057                        )))
058                )));
059
060        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
061                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("CarrierOptionName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
064                ));
065    }
066    
067    /** Creates a new instance of GetCarrierOptionDescriptionCommand */
068    public GetCarrierOptionDescriptionCommand(UserVisitPK userVisitPK, GetCarrierOptionDescriptionForm form) {
069        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        var carrierControl = Session.getModelController(CarrierControl.class);
075        GetCarrierOptionDescriptionResult result = CarrierResultFactory.getGetCarrierOptionDescriptionResult();
076        String carrierName = form.getCarrierName();
077        Carrier carrier = carrierControl.getCarrierByName(carrierName);
078        
079        if(carrier != null) {
080            Party carrierParty = carrier.getParty();
081            String carrierOptionName = form.getCarrierOptionName();
082            CarrierOption carrierOption = carrierControl.getCarrierOptionByName(carrierParty, carrierOptionName);
083            
084            if(carrierOption != null) {
085                var partyControl = Session.getModelController(PartyControl.class);
086                String languageIsoName = form.getLanguageIsoName();
087                Language language = partyControl.getLanguageByIsoName(languageIsoName);
088                
089                if(language != null) {
090                    CarrierOptionDescription carrierOptionDescription = carrierControl.getCarrierOptionDescription(carrierOption, language);
091                    
092                    if(carrierOptionDescription != null) {
093                        result.setCarrierOptionDescription(carrierControl.getCarrierOptionDescriptionTransfer(getUserVisit(), carrierOptionDescription));
094                    } else {
095                        addExecutionError(ExecutionErrors.UnknownCarrierOptionDescription.name(), carrierName, carrierOptionName, languageIsoName);
096                    }
097                } else {
098                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
099                }
100            } else {
101                addExecutionError(ExecutionErrors.UnknownCarrierOptionName.name(), carrierName, carrierOptionName);
102            }
103        } else {
104            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
105        }
106        
107        return result;
108    }
109    
110}