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.GetCommandDescriptionForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.control.CommandControl;
022import com.echothree.model.control.party.server.control.PartyControl;
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.BaseSimpleCommand;
029import com.echothree.util.server.persistence.Session;
030import java.util.List;
031import javax.enterprise.context.Dependent;
032
033@Dependent
034public class GetCommandDescriptionCommand
035        extends BaseSimpleCommand<GetCommandDescriptionForm> {
036    
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038    
039    static {
040        FORM_FIELD_DEFINITIONS = List.of(
041                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
042                new FieldDefinition("CommandName", FieldType.COMMAND_NAME, true, null, null)
043                );
044    }
045    
046    /** Creates a new instance of GetCommandDescriptionCommand */
047    public GetCommandDescriptionCommand() {
048        super(null, FORM_FIELD_DEFINITIONS, true);
049    }
050    
051    @Override
052    protected BaseResult execute() {
053        var commandControl = Session.getModelController(CommandControl.class);
054        var result = CoreResultFactory.getGetCommandDescriptionResult();
055        var componentVendorName = form.getComponentVendorName();
056        var componentVendor = componentControl.getComponentVendorByName(componentVendorName);
057
058        if(componentVendor != null) {
059            var commandName = form.getCommandName();
060            var command = commandControl.getCommandByName(componentVendor, commandName);
061
062            if(command != null) {
063                var partyControl = Session.getModelController(PartyControl.class);
064                var languageIsoName = form.getLanguageIsoName();
065                var language = partyControl.getLanguageByIsoName(languageIsoName);
066
067                if(language != null) {
068                    var commandDescription = commandControl.getCommandDescription(command, language);
069
070                    if(commandDescription != null) {
071                        result.setCommandDescription(commandControl.getCommandDescriptionTransfer(getUserVisit(), commandDescription));
072                    } else {
073                        addExecutionError(ExecutionErrors.UnknownCommandDescription.name());
074                    }
075                } else {
076                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
077                }
078            } else {
079                addExecutionError(ExecutionErrors.UnknownCommandName.name(), commandName);
080            }
081        } else {
082            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
083        }
084
085        return result;
086    }
087    
088}