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.item.server.command;
018
019import com.echothree.control.user.item.common.form.GetItemVolumesForm;
020import com.echothree.control.user.item.common.result.ItemResultFactory;
021import com.echothree.model.control.item.server.control.ItemControl;
022import com.echothree.model.control.item.server.logic.ItemLogic;
023import com.echothree.model.data.item.server.entity.Item;
024import com.echothree.model.data.item.server.entity.ItemVolume;
025import com.echothree.model.data.item.server.factory.ItemVolumeFactory;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
030import java.util.Collection;
031import java.util.List;
032import javax.enterprise.context.Dependent;
033import javax.inject.Inject;
034
035@Dependent
036public class GetItemVolumesCommand
037        extends BasePaginatedMultipleEntitiesCommand<ItemVolume, GetItemVolumesForm> {
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 = List.of(
044                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null)
045        );
046    }
047    
048    @Inject
049    ItemControl itemControl;
050
051    @Inject
052    ItemLogic itemLogic;
053
054    /** Creates a new instance of GetItemVolumesCommand */
055    public GetItemVolumesCommand() {
056        super(null, FORM_FIELD_DEFINITIONS, true);
057    }
058
059    Item item;
060
061    @Override
062    protected void handleForm() {
063        item = itemLogic.getItemByName(this, form.getItemName());
064    }
065
066    @Override
067    protected Long getTotalEntities() {
068        return hasExecutionErrors() ? null : itemControl.countItemVolumesByItem(item);
069    }
070
071    @Override
072    protected Collection<ItemVolume> getEntities() {
073        return hasExecutionErrors() ? null : itemControl.getItemVolumesByItem(item);
074    }
075
076    @Override
077    protected BaseResult getResult(Collection<ItemVolume> entities) {
078        var result = ItemResultFactory.getGetItemVolumesResult();
079
080        if(entities != null) {
081            var userVisit = getUserVisit();
082
083            result.setItem(itemControl.getItemTransfer(userVisit, item));
084
085            if(session.hasLimit(ItemVolumeFactory.class)) {
086                result.setItemVolumeCount(getTotalEntities());
087            }
088
089            result.setItemVolumes(itemControl.getItemVolumeTransfers(userVisit, entities));
090        }
091
092        return result;
093    }
094    
095}