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.GetFreeOnBoardsForm;
020import com.echothree.control.user.shipment.common.result.ShipmentResultFactory;
021import com.echothree.control.user.shipment.common.result.GetFreeOnBoardsResult;
022import com.echothree.model.control.shipment.server.control.FreeOnBoardControl;
023import com.echothree.model.data.shipment.server.entity.FreeOnBoard;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
028import com.echothree.util.server.persistence.Session;
029import java.util.Arrays;
030import java.util.Collection;
031import java.util.Collections;
032import java.util.List;
033
034public class GetFreeOnBoardsCommand
035        extends BaseMultipleEntitiesCommand<FreeOnBoard, GetFreeOnBoardsForm> {
036    
037    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
038    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
039
040    static {
041        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
042                ));
043    }
044    
045    /** Creates a new instance of GetFreeOnBoardsCommand */
046    public GetFreeOnBoardsCommand(UserVisitPK userVisitPK, GetFreeOnBoardsForm form) {
047        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
048    }
049    
050    @Override
051    protected Collection<FreeOnBoard> getEntities() {
052        var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
053        
054        return freeOnBoardControl.getFreeOnBoards();
055    }
056    
057    @Override
058    protected BaseResult getResult(Collection<FreeOnBoard> entities) {
059        GetFreeOnBoardsResult result = ShipmentResultFactory.getGetFreeOnBoardsResult();
060        var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
061        
062        result.setFreeOnBoards(freeOnBoardControl.getFreeOnBoardTransfers(getUserVisit(), entities));
063        
064        return result;
065    }
066    
067}