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