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.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.Dependent;
033import javax.inject.Inject;
034
035@Dependent
036public class GetItemAliasesCommand
037        extends BasePaginatedMultipleEntitiesCommand<ItemAlias, GetItemAliasesForm> {
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    
055    /** Creates a new instance of GetItemAliasesCommand */
056    public GetItemAliasesCommand() {
057        super(null, FORM_FIELD_DEFINITIONS, true);
058    }
059
060    Item item;
061
062    @Override
063    protected void handleForm() {
064        item = itemLogic.getItemByName(this, form.getItemName());
065    }
066
067    @Override
068    protected Long getTotalEntities() {
069        Long totalEntities = null;
070
071        if(!hasExecutionErrors()) {
072            totalEntities = itemControl.countItemAliasesByItem(item);
073        }
074
075        return totalEntities;
076    }
077
078    @Override
079    protected Collection<ItemAlias> getEntities() {
080        Collection<ItemAlias> entities = null;
081
082        if(!hasExecutionErrors()) {
083            entities = itemControl.getItemAliasesByItem(item);
084        }
085
086        return entities;
087    }
088
089    @Override
090    protected BaseResult getResult(Collection<ItemAlias> entities) {
091        var result = ItemResultFactory.getGetItemAliasesResult();
092
093        if(entities != null) {
094            var userVisit = getUserVisit();
095
096            if(session.hasLimit(ItemAliasFactory.class)) {
097                result.setItemAliasCount(getTotalEntities());
098            }
099
100            result.setItem(itemControl.getItemTransfer(userVisit, item));
101            result.setItemAliases(itemControl.getItemAliasTransfers(userVisit, entities));
102        }
103
104        return result;
105    }
106
107}