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