001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.control.user.carrier.common.result.GetCarrierResult;
022import com.echothree.model.control.carrier.server.control.CarrierControl;
023import com.echothree.model.control.core.common.EventTypes;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.party.server.control.PartyControl;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.data.carrier.server.entity.Carrier;
029import com.echothree.model.data.party.server.entity.Party;
030import com.echothree.model.data.party.server.entity.PartyType;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.common.command.BaseResult;
036import com.echothree.util.server.control.BaseSimpleCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class GetCarrierCommand
046        extends BaseSimpleCommand<GetCarrierForm> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
055                        new SecurityRoleDefinition(SecurityRoleGroups.Carrier.name(), SecurityRoles.Review.name())
056                        )))
057                )));
058
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, false, null, null),
061                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null)
062                ));
063    }
064    
065    /** Creates a new instance of GetCarrierCommand */
066    public GetCarrierCommand(UserVisitPK userVisitPK, GetCarrierForm form) {
067        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        GetCarrierResult result = CarrierResultFactory.getGetCarrierResult();
073        String carrierName = form.getCarrierName();
074        String partyName = form.getPartyName();
075        var parameterCount = (carrierName == null ? 0 : 1) + (partyName == null ? 0 : 1);
076        
077        if(parameterCount == 1) {
078            var carrierControl = Session.getModelController(CarrierControl.class);
079            Carrier carrier = null;
080            
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 partyControl = Session.getModelController(PartyControl.class);
089                Party party = partyControl.getPartyByName(partyName);
090                
091                if(party != null) {
092                    PartyType partyType = partyControl.getPartyTypeByName(PartyTypes.CARRIER.name());
093                    
094                    if(party.getLastDetail().getPartyType().equals(partyType)) {
095                        carrier = carrierControl.getCarrier(party);
096                    } else {
097                        addExecutionError(ExecutionErrors.InvalidPartyType.name());
098                    }
099                } else {
100                    addExecutionError(ExecutionErrors.UnknownPartyName.name(), partyName);
101                }
102            }
103            
104            if(!hasExecutionErrors()) {
105                result.setCarrier(carrierControl.getCarrierTransfer(getUserVisit(), carrier));
106                
107                sendEvent(carrier.getPartyPK(), EventTypes.READ, null, null, getPartyPK());
108            }
109        } else {
110            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
111        }
112        
113        return result;
114    }
115    
116}