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.control.core.server.control.CommandControl;
022import com.echothree.model.data.user.common.pk.UserVisitPK;
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 com.echothree.util.server.persistence.Session;
029import java.util.List;
030import javax.enterprise.context.Dependent;
031
032@Dependent
033public class GetCommandDescriptionsCommand
034        extends BaseSimpleCommand<GetCommandDescriptionsForm> {
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    /** 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 commandControl = Session.getModelController(CommandControl.class);
053        var result = CoreResultFactory.getGetCommandDescriptionsResult();
054        var componentVendorName = form.getComponentVendorName();
055        var componentVendor = componentControl.getComponentVendorByName(componentVendorName);
056        
057        if(componentVendor != null) {
058            var commandName = form.getCommandName();
059            var command = commandControl.getCommandByName(componentVendor, commandName);
060            
061            if(command != null) {
062                var userVisit = getUserVisit();
063                
064                result.setCommand(commandControl.getCommandTransfer(userVisit, command));
065                result.setCommandDescriptions(commandControl.getCommandDescriptionTransfersByCommand(userVisit, command));
066            } else {
067                addExecutionError(ExecutionErrors.UnknownCommandName.name(), commandName);
068            }
069        } else {
070            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
071        }
072        
073        return result;
074    }
075    
076}