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.carrier.server.command;
018
019import com.echothree.control.user.carrier.common.form.GetCarrierServiceDescriptionForm;
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 java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetCarrierServiceDescriptionCommand
041        extends BaseSimpleCommand<GetCarrierServiceDescriptionForm> {
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.CarrierService.name(), SecurityRoles.Description.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("CarrierServiceName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060
061    @Inject
062    CarrierControl carrierControl;
063
064    @Inject
065    PartyControl partyControl;
066
067    
068    /** Creates a new instance of GetCarrierServiceDescriptionCommand */
069    public GetCarrierServiceDescriptionCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
071    }
072    
073    @Override
074    protected BaseResult execute() {
075        var result = CarrierResultFactory.getGetCarrierServiceDescriptionResult();
076        var carrierName = form.getCarrierName();
077        var carrier = carrierControl.getCarrierByName(carrierName);
078        
079        if(carrier != null) {
080            var carrierParty = carrier.getParty();
081            var carrierServiceName = form.getCarrierServiceName();
082            var carrierService = carrierControl.getCarrierServiceByName(carrierParty, carrierServiceName);
083            
084            if(carrierService != null) {
085                var languageIsoName = form.getLanguageIsoName();
086                var language = partyControl.getLanguageByIsoName(languageIsoName);
087                
088                if(language != null) {
089                    var carrierServiceDescription = carrierControl.getCarrierServiceDescription(carrierService, language);
090                    
091                    if(carrierServiceDescription != null) {
092                        result.setCarrierServiceDescription(carrierControl.getCarrierServiceDescriptionTransfer(getUserVisit(), carrierServiceDescription));
093                    } else {
094                        addExecutionError(ExecutionErrors.UnknownCarrierServiceDescription.name(), carrierName, carrierServiceName, languageIsoName);
095                    }
096                } else {
097                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
098                }
099            } else {
100                addExecutionError(ExecutionErrors.UnknownCarrierServiceName.name(), carrierName, carrierServiceName);
101            }
102        } else {
103            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
104        }
105        
106        return result;
107    }
108    
109}