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.GetCarrierForm;
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.party.server.logic.PartyLogic;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.carrier.server.entity.Carrier;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSingleEntityCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetCarrierCommand
042        extends BaseSingleEntityCommand<Carrier, GetCarrierForm> {
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(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.Carrier.name(), SecurityRoles.Review.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null)
058        );
059    }
060
061    @Inject
062    CarrierControl carrierControl;
063
064    @Inject
065    PartyLogic partyLogic;
066
067
068    /** Creates a new instance of GetCarrierCommand */
069    public GetCarrierCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
071    }
072    
073    @Override
074    protected Carrier getEntity() {
075        Carrier carrier = null;
076        var carrierName = form.getCarrierName();
077        var partyName = form.getPartyName();
078        var parameterCount = (carrierName == null ? 0 : 1) + (partyName == null ? 0 : 1);
079
080        if(parameterCount == 1) {
081            if(carrierName != null) {
082                carrier = carrierControl.getCarrierByName(carrierName);
083
084                if(carrier == null) {
085                    addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
086                }
087            } else {
088                var party = partyLogic.getPartyByName(this, partyName);
089
090                if(!hasExecutionErrors()) {
091                    partyLogic.checkPartyType(this, party, PartyTypes.CARRIER.name());
092
093                    if(!hasExecutionErrors()) {
094                        carrier = carrierControl.getCarrier(party);
095                    }
096                }
097            }
098
099            if(!hasExecutionErrors()) {
100                sendEvent(carrier.getPartyPK(), EventTypes.READ, null, null, getPartyPK());
101            }
102        } else {
103            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
104        }
105
106        return carrier;
107    }
108
109    @Override
110    protected BaseResult getResult(Carrier carrier) {
111        var result = CarrierResultFactory.getGetCarrierResult();
112
113        if(carrier != null) {
114            result.setCarrier(carrierControl.getCarrierTransfer(getUserVisit(), carrier));
115        }
116
117        return result;
118    }
119    
120}