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.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.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
031import com.echothree.util.server.persistence.Session;
032import java.util.Arrays;
033import java.util.Collection;
034import java.util.Collections;
035import java.util.List;
036
037public class GetItemAliasesCommand
038        extends BaseMultipleEntitiesCommand<ItemAlias, GetItemAliasesForm> {
039
040    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
045                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null)
046                ));
047    }
048    
049    /** Creates a new instance of GetItemAliasesCommand */
050    public GetItemAliasesCommand(UserVisitPK userVisitPK, GetItemAliasesForm form) {
051        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
052    }
053
054    Item item;
055
056    @Override
057    protected Collection<ItemAlias> getEntities() {
058        var itemControl = Session.getModelController(ItemControl.class);
059        Collection<ItemAlias> itemAliases = null;
060
061        item = ItemLogic.getInstance().getItemByName(this, form.getItemName());
062
063        if(!hasExecutionErrors()) {
064            itemAliases = itemControl.getItemAliasesByItem(item);
065        }
066
067        return itemAliases;
068    }
069
070    @Override
071    protected BaseResult getResult(Collection<ItemAlias> entities) {
072        var result = ItemResultFactory.getGetItemAliasesResult();
073
074        if(entities != null) {
075            var itemControl = Session.getModelController(ItemControl.class);
076            var userVisit = getUserVisit();
077
078            if(session.hasLimit(ItemAliasFactory.class)) {
079                result.setItemAliasCount(itemControl.countItemAliasesByItem(item));
080            }
081
082            result.setItem(itemControl.getItemTransfer(userVisit, item));
083            result.setItemAliases(itemControl.getItemAliasTransfers(userVisit, entities));
084        }
085
086        return result;
087    }
088
089}