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