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.GetItemForm;
020import com.echothree.control.user.item.common.result.ItemResultFactory;
021import com.echothree.model.control.core.common.ComponentVendors;
022import com.echothree.model.control.core.common.EntityTypes;
023import com.echothree.model.control.core.common.EventTypes;
024import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
025import com.echothree.model.control.item.server.control.ItemControl;
026import com.echothree.model.control.item.server.logic.ItemLogic;
027import com.echothree.model.data.item.server.entity.Item;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseSingleEntityCommand;
034import com.echothree.util.server.persistence.Session;
035import java.util.List;
036import javax.enterprise.context.RequestScoped;
037
038@RequestScoped
039public class GetItemCommand
040        extends BaseSingleEntityCommand<Item, GetItemForm> {
041    
042    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        FORM_FIELD_DEFINITIONS = List.of(
047                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, false, null, null),
048                new FieldDefinition("ItemNameOrAlias", FieldType.ENTITY_NAME, false, null, null),
049                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
050                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
051        );
052    }
053    
054    /** Creates a new instance of GetItemCommand */
055    public GetItemCommand() {
056        super(null, FORM_FIELD_DEFINITIONS, true);
057    }
058    
059    @Override
060    protected Item getEntity() {
061        var itemControl = Session.getModelController(ItemControl.class);
062        Item item = null;
063        var itemName = form.getItemName();
064        var itemNameOrAlias = form.getItemNameOrAlias();
065        var parameterCount = (itemName == null ? 0 : 1) + (itemNameOrAlias == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(form);
066
067        if(parameterCount == 1) {
068            if(itemName == null && itemNameOrAlias == null) {
069                var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, form,
070                        ComponentVendors.ECHO_THREE.name(), EntityTypes.Item.name());
071
072                if(!hasExecutionErrors()) {
073                    item = itemControl.getItemByEntityInstance(entityInstance);
074                }
075            } else {
076                item = itemNameOrAlias == null ? ItemLogic.getInstance().getItemByName(this, itemName) : ItemLogic.getInstance().getItemByNameThenAlias(this, itemNameOrAlias);
077            }
078
079            if(item != null) {
080                sendEvent(item.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
081            }
082        } else {
083            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
084        }
085        
086        return item;
087    }
088    
089    @Override
090    protected BaseResult getResult(Item item) {
091        var itemControl = Session.getModelController(ItemControl.class);
092        var result = ItemResultFactory.getGetItemResult();
093
094        if(item != null) {
095            result.setItem(itemControl.getItemTransfer(getUserVisit(), item));
096        }
097
098        return result;
099    }
100    
101}