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.GetCarrierServiceOptionForm;
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.carrier.server.entity.CarrierServiceOption;
026import com.echothree.util.common.command.BaseResult;
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.server.control.BaseSingleEntityCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
039public class GetCarrierServiceOptionCommand
040        extends BaseSingleEntityCommand<CarrierServiceOption, GetCarrierServiceOptionForm> {
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.Review.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, true, null, null),
056                new FieldDefinition("CarrierOptionName", FieldType.ENTITY_NAME, true, null, null)
057        );
058    }
059    
060    @Inject
061    CarrierControl carrierControl;
062
063    /** Creates a new instance of GetCarrierServiceOptionCommand */
064    public GetCarrierServiceOptionCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067    
068    @Override
069    protected CarrierServiceOption getEntity() {
070        CarrierServiceOption carrierServiceOption = null;
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 carrierService = carrierControl.getCarrierServiceByName(carrierParty, carrierServiceName);
078
079            if(carrierService != null) {
080                var carrierOptionName = form.getCarrierOptionName();
081                var carrierOption = carrierControl.getCarrierOptionByName(carrierParty, carrierOptionName);
082
083                if(carrierOption != null) {
084                    carrierServiceOption = carrierControl.getCarrierServiceOption(carrierService, carrierOption);
085
086                    if(carrierServiceOption == null) {
087                        addExecutionError(ExecutionErrors.UnknownCarrierServiceOption.name(), carrierName, carrierServiceName, carrierOptionName);
088                    }
089                } else {
090                    addExecutionError(ExecutionErrors.UnknownCarrierOptionName.name(), carrierName, carrierOptionName);
091                }
092            } else {
093                addExecutionError(ExecutionErrors.UnknownCarrierServiceName.name(), carrierName, carrierServiceName);
094            }
095        } else {
096            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
097        }
098
099        return carrierServiceOption;
100    }
101
102    @Override
103    protected BaseResult getResult(CarrierServiceOption carrierServiceOption) {
104        var result = CarrierResultFactory.getGetCarrierServiceOptionResult();
105
106        if(carrierServiceOption != null) {
107            result.setCarrierServiceOption(carrierControl.getCarrierServiceOptionTransfer(getUserVisit(), carrierServiceOption));
108        }
109
110        return result;
111    }
112    
113}