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.GetShipmentAliasesForm;
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 GetShipmentAliasesCommand
039        extends BaseSimpleCommand<GetShipmentAliasesForm> {
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                );
048    }
049    
050    /** Creates a new instance of GetShipmentAliasesCommand */
051    public GetShipmentAliasesCommand() {
052        super(null, FORM_FIELD_DEFINITIONS, false);
053    }
054
055    @Override
056    protected CommandSecurityDefinition getCommandSecurityDefinition() {
057        return new CommandSecurityDefinition(List.of(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
060                        new SecurityRoleDefinition(ShipmentAliasUtil.getInstance().getSecurityRoleGroupNameByShipmentTypeSpec(form), SecurityRoles.List.name())
061                ))
062        ));
063    }
064
065    @Override
066    protected BaseResult execute() {
067        var shipmentControl = Session.getModelController(ShipmentControl.class);
068        var result = ShipmentResultFactory.getGetShipmentAliasesResult();
069        var shipmentTypeName = form.getShipmentTypeName();
070        var shipmentType = shipmentControl.getShipmentTypeByName(shipmentTypeName);
071
072        if(shipmentType != null) {
073            var shipmentName = form.getShipmentName();
074            var shipment = shipmentControl.getShipmentByName(shipmentType, shipmentName);
075
076            if(shipment != null) {
077                var userVisit = getUserVisit();
078
079                result.setShipment(shipmentControl.getShipmentTransfer(userVisit, shipment));
080                result.setShipmentAliases(shipmentControl.getShipmentAliasTransfersByShipment(userVisit, shipment));
081            } else {
082                addExecutionError(ExecutionErrors.UnknownShipmentName.name(), shipmentTypeName, shipmentName);
083            }
084        } else {
085            addExecutionError(ExecutionErrors.UnknownShipmentTypeName.name(), shipmentTypeName);
086        }
087
088        return result;
089    }
090    
091}