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.GetFreeOnBoardsForm;
020import com.echothree.control.user.shipment.common.result.ShipmentResultFactory;
021import com.echothree.model.control.shipment.server.control.FreeOnBoardControl;
022import com.echothree.model.data.shipment.server.entity.FreeOnBoard;
023import com.echothree.model.data.shipment.server.factory.FreeOnBoardFactory;
024import com.echothree.util.common.command.BaseResult;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
027import com.echothree.util.server.persistence.Session;
028import java.util.Collection;
029import java.util.List;
030import javax.enterprise.context.RequestScoped;
031
032@RequestScoped
033public class GetFreeOnBoardsCommand
034        extends BasePaginatedMultipleEntitiesCommand<FreeOnBoard, GetFreeOnBoardsForm> {
035
036    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038
039    static {
040        FORM_FIELD_DEFINITIONS = List.of();
041    }
042
043    /** Creates a new instance of GetFreeOnBoardsCommand */
044    public GetFreeOnBoardsCommand() {
045        super(null, FORM_FIELD_DEFINITIONS, true);
046    }
047
048    @Override
049    protected void handleForm() {
050        // No form fields.
051    }
052
053    @Override
054    protected Long getTotalEntities() {
055        var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
056
057        return freeOnBoardControl.countFreeOnBoards();
058    }
059
060    @Override
061    protected Collection<FreeOnBoard> getEntities() {
062        var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
063
064        return freeOnBoardControl.getFreeOnBoards();
065    }
066
067    @Override
068    protected BaseResult getResult(Collection<FreeOnBoard> entities) {
069        var result = ShipmentResultFactory.getGetFreeOnBoardsResult();
070
071        if(entities != null) {
072            var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
073
074            if(session.hasLimit(FreeOnBoardFactory.class)) {
075                result.setFreeOnBoardCount(getTotalEntities());
076            }
077
078            result.setFreeOnBoards(freeOnBoardControl.getFreeOnBoardTransfers(getUserVisit(), entities));
079        }
080
081        return result;
082    }
083
084}