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.GetPartyCarrierForm;
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.PartyCarrier;
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 GetPartyCarrierCommand
042        extends BaseSingleEntityCommand<PartyCarrier, GetPartyCarrierForm> {
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.PartyCarrier.name(), SecurityRoles.Review.name())
052                ))
053        ));
054        
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("PartyName", FieldType.HOST_NAME, true, null, null),
057                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060    
061    @Inject
062    CarrierControl carrierControl;
063
064    @Inject
065    PartyLogic partyLogic;
066
067    /** Creates a new instance of GetPartyCarrierCommand */
068    public GetPartyCarrierCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected PartyCarrier getEntity() {
074        PartyCarrier partyCarrier = null;
075        var partyName = form.getPartyName();
076        var party = partyLogic.getPartyByName(this, partyName);
077
078        if(!hasExecutionErrors()) {
079            var carrierName = form.getCarrierName();
080            var carrier = carrierControl.getCarrierByName(carrierName);
081
082            if(carrier != null) {
083                partyCarrier = carrierControl.getPartyCarrier(party, carrier.getParty());
084
085                if(partyCarrier == null) {
086                    addExecutionError(ExecutionErrors.UnknownPartyCarrier.name(), partyName, carrierName);
087                }
088            } else {
089                addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
090            }
091        }
092
093        return partyCarrier;
094    }
095
096    @Override
097    protected BaseResult getResult(PartyCarrier partyCarrier) {
098        var result = CarrierResultFactory.getGetPartyCarrierResult();
099
100        if(partyCarrier != null) {
101            result.setPartyCarrier(carrierControl.getPartyCarrierTransfer(getUserVisit(), partyCarrier));
102        }
103
104        return result;
105    }
106    
107}