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.shipment.server.command;
018
019import com.echothree.control.user.shipment.common.form.GetShipmentAliasForm;
020import com.echothree.control.user.shipment.common.result.ShipmentResultFactory;
021import com.echothree.control.user.shipment.server.command.util.ShipmentAliasUtil;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.shipment.server.control.ShipmentControl;
025import com.echothree.util.common.command.BaseResult;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import com.echothree.util.server.persistence.Session;
034import java.util.Arrays;
035import java.util.Collections;
036import java.util.List;
037import javax.enterprise.context.RequestScoped;
038
039@RequestScoped
040public class GetShipmentAliasCommand
041        extends BaseSimpleCommand<GetShipmentAliasForm> {
042    
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
047                new FieldDefinition("ShipmentTypeName", FieldType.ENTITY_NAME, true, null, null),
048                new FieldDefinition("ShipmentName", FieldType.ENTITY_NAME, true, null, null),
049                new FieldDefinition("ShipmentAliasTypeName", FieldType.ENTITY_NAME, true, null, null)
050                ));
051    }
052    
053    /** Creates a new instance of GetShipmentAliasCommand */
054    public GetShipmentAliasCommand() {
055        super(null, FORM_FIELD_DEFINITIONS, false);
056    }
057
058    @Override
059    protected CommandSecurityDefinition getCommandSecurityDefinition() {
060        return new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
061                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
062                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
063                        new SecurityRoleDefinition(ShipmentAliasUtil.getInstance().getSecurityRoleGroupNameByShipmentTypeSpec(form), SecurityRoles.Review.name())
064                )))
065        )));
066    }
067
068    @Override
069    protected BaseResult execute() {
070        var shipmentControl = Session.getModelController(ShipmentControl.class);
071        var result = ShipmentResultFactory.getGetShipmentAliasResult();
072        var shipmentTypeName = form.getShipmentTypeName();
073        var shipmentType = shipmentControl.getShipmentTypeByName(shipmentTypeName);
074
075        if(shipmentType != null) {
076            var shipmentName = form.getShipmentName();
077            var shipment = shipmentControl.getShipmentByName(shipmentType, shipmentName);
078
079            if(shipment != null) {
080                var shipmentAliasTypeName = form.getShipmentAliasTypeName();
081                var shipmentAliasType = shipmentControl.getShipmentAliasTypeByName(shipmentType, shipmentAliasTypeName);
082
083                if(shipmentAliasType != null) {
084                    var shipmentAlias = shipmentControl.getShipmentAlias(shipment, shipmentAliasType);
085
086                    if(shipmentAlias != null) {
087                        result.setShipmentAlias(shipmentControl.getShipmentAliasTransfer(getUserVisit(), shipmentAlias));
088                    } else {
089                        addExecutionError(ExecutionErrors.UnknownShipmentAlias.name(), shipmentName, shipmentAliasTypeName);
090                    }
091                } else {
092                    addExecutionError(ExecutionErrors.UnknownShipmentAliasTypeName.name(), shipmentTypeName, shipmentAliasTypeName);
093                }
094            } else {
095                addExecutionError(ExecutionErrors.UnknownShipmentName.name(), shipmentTypeName, shipmentName);
096            }
097        } else {
098            addExecutionError(ExecutionErrors.UnknownShipmentTypeName.name(), shipmentTypeName);
099        }
100
101        return result;
102    }
103    
104}