001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.control.PartyControl;
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.model.data.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Arrays;
039import java.util.Collections;
040import java.util.List;
041import javax.enterprise.context.RequestScoped;
042
043@RequestScoped
044public class GetCarrierCommand
045        extends BaseSimpleCommand<GetCarrierForm> {
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.Carrier.name(), SecurityRoles.Review.name())
055                        )))
056                )));
057
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, false, null, null),
060                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetCarrierCommand */
065    public GetCarrierCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var result = CarrierResultFactory.getGetCarrierResult();
072        var carrierName = form.getCarrierName();
073        var partyName = form.getPartyName();
074        var parameterCount = (carrierName == null ? 0 : 1) + (partyName == null ? 0 : 1);
075        
076        if(parameterCount == 1) {
077            var carrierControl = Session.getModelController(CarrierControl.class);
078            Carrier carrier = null;
079            
080            if(carrierName != null) {
081                carrier = carrierControl.getCarrierByName(carrierName);
082                
083                if(carrier == null) {
084                    addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
085                }
086            } else {
087                var partyControl = Session.getModelController(PartyControl.class);
088                var party = partyControl.getPartyByName(partyName);
089                
090                if(party != null) {
091                    var partyType = partyControl.getPartyTypeByName(PartyTypes.CARRIER.name());
092                    
093                    if(party.getLastDetail().getPartyType().equals(partyType)) {
094                        carrier = carrierControl.getCarrier(party);
095                    } else {
096                        addExecutionError(ExecutionErrors.InvalidPartyType.name());
097                    }
098                } else {
099                    addExecutionError(ExecutionErrors.UnknownPartyName.name(), partyName);
100                }
101            }
102            
103            if(!hasExecutionErrors()) {
104                result.setCarrier(carrierControl.getCarrierTransfer(getUserVisit(), carrier));
105                
106                sendEvent(carrier.getPartyPK(), EventTypes.READ, null, null, getPartyPK());
107            }
108        } else {
109            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
110        }
111        
112        return result;
113    }
114    
115}