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