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