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