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