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 java.util.List;
031import javax.enterprise.context.Dependent;
032import javax.inject.Inject;
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    @Inject
050    FreeOnBoardControl freeOnBoardControl;
051
052    @Inject
053    FreeOnBoardLogic freeOnBoardLogic;
054
055    
056    /** Creates a new instance of GetFreeOnBoardCommand */
057    public GetFreeOnBoardCommand() {
058        super(null, FORM_FIELD_DEFINITIONS, true);
059    }
060    
061    @Override
062    protected FreeOnBoard getEntity() {
063        var freeOnBoard = freeOnBoardLogic.getFreeOnBoardByUniversalSpec(this, form, true);
064
065        if(freeOnBoard != null) {
066            sendEvent(freeOnBoard.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
067        }
068
069        return freeOnBoard;
070    }
071    
072    @Override
073    protected BaseResult getResult(FreeOnBoard freeOnBoard) {
074        var result = ShipmentResultFactory.getGetFreeOnBoardResult();
075
076        if(freeOnBoard != null) {
077            result.setFreeOnBoard(freeOnBoardControl.getFreeOnBoardTransfer(getUserVisit(), freeOnBoard));
078        }
079
080        return result;
081    }
082    
083}