001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.GetMessageDescriptionsResult;
021import com.echothree.control.user.message.common.result.MessageResultFactory;
022import com.echothree.model.control.message.server.control.MessageControl;
023import com.echothree.model.data.core.server.entity.ComponentVendor;
024import com.echothree.model.data.core.server.entity.EntityType;
025import com.echothree.model.data.message.server.entity.Message;
026import com.echothree.model.data.message.server.entity.MessageType;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.persistence.Session;
034import java.util.Arrays;
035import java.util.Collections;
036import java.util.List;
037
038public class GetMessageDescriptionsCommand
039        extends BaseSimpleCommand<GetMessageDescriptionsForm> {
040    
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
045            new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
046            new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
047            new FieldDefinition("MessageTypeName", FieldType.ENTITY_NAME, true, null, null),
048            new FieldDefinition("MessageName", FieldType.ENTITY_NAME, true, null, null)
049        ));
050    }
051    
052    /** Creates a new instance of GetMessageDescriptionsCommand */
053    public GetMessageDescriptionsCommand(UserVisitPK userVisitPK, GetMessageDescriptionsForm form) {
054        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
055    }
056    
057    @Override
058    protected BaseResult execute() {
059        var coreControl = getCoreControl();
060        GetMessageDescriptionsResult result = MessageResultFactory.getGetMessageDescriptionsResult();
061        String componentVendorName = form.getComponentVendorName();
062        ComponentVendor componentVendor = coreControl.getComponentVendorByName(componentVendorName);
063        
064        if(componentVendor != null) {
065            String entityTypeName = form.getEntityTypeName();
066            EntityType entityType = coreControl.getEntityTypeByName(componentVendor, entityTypeName);
067            
068            if(entityType != null) {
069                var messageControl = Session.getModelController(MessageControl.class);
070                String messageTypeName = form.getMessageTypeName();
071                MessageType messageType = messageControl.getMessageTypeByName(entityType, messageTypeName);
072                
073                if(messageType != null) {
074                    String messageName = form.getMessageName();
075                    Message message = messageControl.getMessageByName(messageType, messageName);
076                    
077                    if(message != null) {
078                        result.setMessage(messageControl.getMessageTransfer(getUserVisit(), message));
079                        result.setMessageDescriptions(messageControl.getMessageDescriptionTransfers(getUserVisit(), message));
080                    } else {
081                        addExecutionError(ExecutionErrors.UnknownMessageName.name(), messageName);
082                    }
083                } else {
084                    addExecutionError(ExecutionErrors.UnknownMessageTypeName.name(), messageTypeName);
085                }
086            } else {
087                addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), entityTypeName);
088            }
089        } else {
090            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
091        }
092        
093        return result;
094    }
095    
096}