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