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.GetFreeOnBoardForm;
020import com.echothree.control.user.shipment.common.result.ShipmentResultFactory;
021import com.echothree.model.control.shipment.server.control.FreeOnBoardControl;
022import com.echothree.model.control.shipment.server.logic.FreeOnBoardLogic;
023import com.echothree.model.control.core.common.EventTypes;
024import com.echothree.model.data.shipment.server.entity.FreeOnBoard;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.server.control.BaseSingleEntityCommand;
030import com.echothree.util.server.persistence.Session;
031import java.util.List;
032import javax.enterprise.context.Dependent;
033
034@Dependent
035public class GetFreeOnBoardCommand
036        extends BaseSingleEntityCommand<FreeOnBoard, GetFreeOnBoardForm> {
037    
038    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        FORM_FIELD_DEFINITIONS = List.of(
043                new FieldDefinition("FreeOnBoardName", FieldType.ENTITY_NAME, false, null, null),
044                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
045                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
046                );
047    }
048    
049    /** Creates a new instance of GetFreeOnBoardCommand */
050    public GetFreeOnBoardCommand() {
051        super(null, FORM_FIELD_DEFINITIONS, true);
052    }
053    
054    @Override
055    protected FreeOnBoard getEntity() {
056        var freeOnBoard = FreeOnBoardLogic.getInstance().getFreeOnBoardByUniversalSpec(this, form, true);
057
058        if(freeOnBoard != null) {
059            sendEvent(freeOnBoard.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
060        }
061
062        return freeOnBoard;
063    }
064    
065    @Override
066    protected BaseResult getResult(FreeOnBoard freeOnBoard) {
067        var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
068        var result = ShipmentResultFactory.getGetFreeOnBoardResult();
069
070        if(freeOnBoard != null) {
071            result.setFreeOnBoard(freeOnBoardControl.getFreeOnBoardTransfer(getUserVisit(), freeOnBoard));
072        }
073
074        return result;
075    }
076    
077}