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