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.core.server.command;
018
019import com.echothree.control.user.core.common.form.GetCommandForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.control.CommandControl;
022import com.echothree.model.control.core.server.logic.ComponentVendorLogic;
023import com.echothree.util.common.command.BaseResult;
024import com.echothree.util.common.message.ExecutionErrors;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.common.validation.FieldType;
027import com.echothree.util.server.control.BaseSimpleCommand;
028import java.util.List;
029import javax.enterprise.context.Dependent;
030import javax.inject.Inject;
031
032@Dependent
033public class GetCommandCommand
034        extends BaseSimpleCommand<GetCommandForm> {
035
036    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
037
038    static {
039        FORM_FIELD_DEFINITIONS = List.of(
040                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
041                new FieldDefinition("CommandName", FieldType.COMMAND_NAME, true, null, null)
042        );
043    }
044
045    @Inject
046    ComponentVendorLogic componentVendorLogic;
047
048    /** Creates a new instance of GetCommandCommand */
049    public GetCommandCommand() {
050        super(null, FORM_FIELD_DEFINITIONS, true);
051    }
052
053    @Override
054    protected BaseResult execute() {
055        var result = CoreResultFactory.getGetCommandResult();
056        var componentVendorName = form.getComponentVendorName();
057        var componentVendor = componentVendorLogic.getComponentVendorByName(this, componentVendorName);
058
059        if(!hasExecutionErrors()) {
060            var commandName = form.getCommandName();
061            var command = commandControl.getCommandByName(componentVendor, commandName);
062
063            if(command != null) {
064                var userVisit = getUserVisit();
065
066                result.setCommand(commandControl.getCommandTransfer(userVisit, command));
067            } else {
068                addExecutionError(ExecutionErrors.UnknownCommandName.name(), commandName);
069            }
070        }
071
072        return result;
073    }
074
075}