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.item.server.command;
018
019import com.echothree.control.user.item.common.form.GetItemAliasesForm;
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.ItemAlias;
025import com.echothree.model.data.item.server.factory.ItemAliasFactory;
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.RequestScoped;
033import javax.inject.Inject;
034
035@RequestScoped
036public class GetItemAliasesCommand
037        extends BasePaginatedMultipleEntitiesCommand<ItemAlias, GetItemAliasesForm> {
038
039    @Inject
040    ItemControl itemControl;
041
042    @Inject
043    ItemLogic itemLogic;
044
045    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        FORM_FIELD_DEFINITIONS = List.of(
050                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null)
051        );
052    }
053    
054    /** Creates a new instance of GetItemAliasesCommand */
055    public GetItemAliasesCommand() {
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        Long totalEntities = null;
069
070        if(!hasExecutionErrors()) {
071            totalEntities = itemControl.countItemAliasesByItem(item);
072        }
073
074        return totalEntities;
075    }
076
077    @Override
078    protected Collection<ItemAlias> getEntities() {
079        Collection<ItemAlias> entities = null;
080
081        if(!hasExecutionErrors()) {
082            entities = itemControl.getItemAliasesByItem(item);
083        }
084
085        return entities;
086    }
087
088    @Override
089    protected BaseResult getResult(Collection<ItemAlias> entities) {
090        var result = ItemResultFactory.getGetItemAliasesResult();
091
092        if(entities != null) {
093            var userVisit = getUserVisit();
094
095            if(session.hasLimit(ItemAliasFactory.class)) {
096                result.setItemAliasCount(getTotalEntities());
097            }
098
099            result.setItem(itemControl.getItemTransfer(userVisit, item));
100            result.setItemAliases(itemControl.getItemAliasTransfers(userVisit, entities));
101        }
102
103        return result;
104    }
105
106}