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.message.server.command;
018
019import com.echothree.control.user.message.common.form.GetMessageDescriptionsForm;
020import com.echothree.control.user.message.common.result.MessageResultFactory;
021import com.echothree.model.control.message.server.control.MessageControl;
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 java.util.List;
029import javax.enterprise.context.Dependent;
030import javax.inject.Inject;
031
032@Dependent
033public class GetMessageDescriptionsCommand
034        extends BaseSimpleCommand<GetMessageDescriptionsForm> {
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("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
042                new FieldDefinition("MessageTypeName", FieldType.ENTITY_NAME, true, null, null),
043                new FieldDefinition("MessageName", FieldType.ENTITY_NAME, true, null, null)
044        );
045    }
046
047    @Inject
048    MessageControl messageControl;
049
050    
051    /** Creates a new instance of GetMessageDescriptionsCommand */
052    public GetMessageDescriptionsCommand() {
053        super(null, FORM_FIELD_DEFINITIONS, true);
054    }
055    
056    @Override
057    protected BaseResult execute() {
058        var result = MessageResultFactory.getGetMessageDescriptionsResult();
059        var componentVendorName = form.getComponentVendorName();
060        var componentVendor = componentControl.getComponentVendorByName(componentVendorName);
061        
062        if(componentVendor != null) {
063            var entityTypeName = form.getEntityTypeName();
064            var entityType = entityTypeControl.getEntityTypeByName(componentVendor, entityTypeName);
065            
066            if(entityType != null) {
067                var messageTypeName = form.getMessageTypeName();
068                var messageType = messageControl.getMessageTypeByName(entityType, messageTypeName);
069                
070                if(messageType != null) {
071                    var messageName = form.getMessageName();
072                    var message = messageControl.getMessageByName(messageType, messageName);
073                    
074                    if(message != null) {
075                        result.setMessage(messageControl.getMessageTransfer(getUserVisit(), message));
076                        result.setMessageDescriptions(messageControl.getMessageDescriptionTransfers(getUserVisit(), message));
077                    } else {
078                        addExecutionError(ExecutionErrors.UnknownMessageName.name(), messageName);
079                    }
080                } else {
081                    addExecutionError(ExecutionErrors.UnknownMessageTypeName.name(), messageTypeName);
082                }
083            } else {
084                addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), entityTypeName);
085            }
086        } else {
087            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
088        }
089        
090        return result;
091    }
092    
093}