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.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;
033
034public class GetItemAliasCommand
035        extends BaseSingleEntityCommand<ItemAlias, GetItemAliasForm> {
036
037    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
038    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
039    
040    static {
041        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
042                new FieldDefinition("Alias", FieldType.ENTITY_NAME, true, null, null)
043                ));
044    }
045    
046    /** Creates a new instance of GetItemAliasCommand */
047    public GetItemAliasCommand(UserVisitPK userVisitPK, GetItemAliasForm form) {
048        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
049    }
050
051    @Override
052    protected ItemAlias getEntity() {
053        var itemControl = Session.getModelController(ItemControl.class);
054        var alias = form.getAlias();
055        var itemAlias = itemControl.getItemAliasByAliasForUpdate(alias);
056
057        if(itemAlias == null) {
058            addExecutionError(ExecutionErrors.UnknownItemAlias.name(), alias);
059        }
060
061        return itemAlias;
062    }
063
064    @Override
065    protected BaseResult getResult(ItemAlias entity) {
066        var result = ItemResultFactory.getGetItemAliasResult();
067
068        if(entity != null) {
069            var itemControl = Session.getModelController(ItemControl.class);
070
071            result.setItemAlias(itemControl.getItemAliasTransfer(getUserVisit(), entity));
072        }
073
074        return result;
075    }
076
077}