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.GetCarrierOptionForm;
020import com.echothree.control.user.carrier.common.result.CarrierResultFactory;
021import com.echothree.model.control.carrier.server.control.CarrierControl;
022import com.echothree.model.control.core.common.EventTypes;
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.CarrierOption;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSingleEntityCommand;
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 GetCarrierOptionCommand
041        extends BaseSingleEntityCommand<CarrierOption, GetCarrierOptionForm> {
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.CarrierOption.name(), SecurityRoles.Review.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("CarrierName", 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 GetCarrierOptionCommand */
064    public GetCarrierOptionCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067    
068    @Override
069    protected CarrierOption getEntity() {
070        CarrierOption carrierOption = null;
071        var carrierName = form.getCarrierName();
072        var carrier = carrierControl.getCarrierByName(carrierName);
073
074        if(carrier != null) {
075            var carrierParty = carrier.getParty();
076            var carrierOptionName = form.getCarrierOptionName();
077
078            carrierOption = carrierControl.getCarrierOptionByName(carrierParty, carrierOptionName);
079
080            if(carrierOption != null) {
081                sendEvent(carrierOption.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
082            } else {
083                addExecutionError(ExecutionErrors.UnknownCarrierOptionName.name(), carrierName, carrierOptionName);
084            }
085        } else {
086            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
087        }
088
089        return carrierOption;
090    }
091
092    @Override
093    protected BaseResult getResult(CarrierOption carrierOption) {
094        var result = CarrierResultFactory.getGetCarrierOptionResult();
095
096        if(carrierOption != null) {
097            result.setCarrierOption(carrierControl.getCarrierOptionTransfer(getUserVisit(), carrierOption));
098        }
099
100        return result;
101    }
102
103}