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.GetCarrierServiceOptionsForm;
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.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037
038@Dependent
039public class GetCarrierServiceOptionsCommand
040        extends BaseSimpleCommand<GetCarrierServiceOptionsForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.CarrierServiceOption.name(), SecurityRoles.List.name())
050                        ))
051                ));
052
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("CarrierServiceName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("CarrierOptionName", FieldType.ENTITY_NAME, false, null, null)
057                );
058    }
059    
060    /** Creates a new instance of GetCarrierServiceOptionsCommand */
061    public GetCarrierServiceOptionsCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var carrierControl = Session.getModelController(CarrierControl.class);
068        var result = CarrierResultFactory.getGetCarrierServiceOptionsResult();
069        var carrierName = form.getCarrierName();
070        var carrier = carrierControl.getCarrierByName(carrierName);
071        
072        if(carrier != null) {
073            var carrierParty = carrier.getParty();
074            var carrierServiceName = form.getCarrierServiceName();
075            var carrierOptionName = form.getCarrierOptionName();
076            var parameterCount = (carrierServiceName == null ? 0 : 1) + (carrierOptionName == null ? 0 : 1);
077            
078            if(parameterCount == 1) {
079                if(carrierServiceName != null) {
080                    var carrierService = carrierControl.getCarrierServiceByName(carrierParty, carrierServiceName);
081                    
082                    if(carrierService != null) {
083                        result.setCarrierService(carrierControl.getCarrierServiceTransfer(getUserVisit(), carrierService));
084                        result.setCarrierServiceOptions(carrierControl.getCarrierServiceOptionTransfersByCarrierService(getUserVisit(),
085                                carrierService));
086                    } else {
087                        addExecutionError(ExecutionErrors.UnknownCarrierServiceName.name(), carrierName, carrierServiceName);
088                    }
089                }
090                
091                if(carrierOptionName != null) {
092                    var carrierOption = carrierControl.getCarrierOptionByName(carrierParty, carrierOptionName);
093                    
094                    if(carrierOption != null) {
095                        result.setCarrierOption(carrierControl.getCarrierOptionTransfer(getUserVisit(), carrierOption));
096                        result.setCarrierServiceOptions(carrierControl.getCarrierServiceOptionTransfersByCarrierOption(getUserVisit(),
097                                carrierOption));
098                    } else {
099                        addExecutionError(ExecutionErrors.UnknownCarrierOptionName.name(), carrierName, carrierOptionName);
100                    }
101                }
102            } else {
103                addExecutionError(ExecutionErrors.InvalidParameterCount.name());
104            }
105        } else {
106            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
107        }
108        
109        return result;
110    }
111    
112}