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.GetItemAliasForm;
020import com.echothree.control.user.item.common.result.ItemResultFactory;
021import com.echothree.model.control.item.server.control.ItemControl;
022import com.echothree.model.data.item.server.entity.ItemAlias;
023import com.echothree.model.data.user.common.pk.UserVisitPK;
024import com.echothree.util.common.command.BaseResult;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.server.control.BaseSingleEntityCommand;
029import com.echothree.util.server.persistence.Session;
030import java.util.Arrays;
031import java.util.Collections;
032import java.util.List;
033import javax.enterprise.context.RequestScoped;
034
035@RequestScoped
036public class GetItemAliasCommand
037        extends BaseSingleEntityCommand<ItemAlias, GetItemAliasForm> {
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 = Collections.unmodifiableList(Arrays.asList(
044                new FieldDefinition("Alias", FieldType.ENTITY_NAME, true, null, null)
045                ));
046    }
047    
048    /** Creates a new instance of GetItemAliasCommand */
049    public GetItemAliasCommand() {
050        super(null, FORM_FIELD_DEFINITIONS, false);
051    }
052
053    @Override
054    protected ItemAlias getEntity() {
055        var itemControl = Session.getModelController(ItemControl.class);
056        var alias = form.getAlias();
057        var itemAlias = itemControl.getItemAliasByAliasForUpdate(alias);
058
059        if(itemAlias == null) {
060            addExecutionError(ExecutionErrors.UnknownItemAlias.name(), alias);
061        }
062
063        return itemAlias;
064    }
065
066    @Override
067    protected BaseResult getResult(ItemAlias entity) {
068        var result = ItemResultFactory.getGetItemAliasResult();
069
070        if(entity != null) {
071            var itemControl = Session.getModelController(ItemControl.class);
072
073            result.setItemAlias(itemControl.getItemAliasTransfer(getUserVisit(), entity));
074        }
075
076        return result;
077    }
078
079}