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.GetEntityMessagesForm;
020import com.echothree.control.user.message.common.result.GetEntityMessagesResult;
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.EntityInstance;
025import com.echothree.model.data.core.server.entity.EntityType;
026import com.echothree.model.data.message.server.entity.Message;
027import com.echothree.model.data.message.server.entity.MessageType;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.model.data.user.server.entity.UserVisit;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.server.control.BaseSimpleCommand;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039
040public class GetEntityMessagesCommand
041        extends BaseSimpleCommand<GetEntityMessagesForm> {
042    
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
047            new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
048            new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
049            new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
050            new FieldDefinition("MessageTypeName", FieldType.ENTITY_NAME, false, null, null),
051            new FieldDefinition("MessageName", FieldType.TAG, false, null, null)
052        ));
053    }
054    
055    /** Creates a new instance of GetEntityMessagesCommand */
056    public GetEntityMessagesCommand(UserVisitPK userVisitPK, GetEntityMessagesForm form) {
057        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
058    }
059    
060    @Override
061    protected BaseResult execute() {
062        GetEntityMessagesResult result = MessageResultFactory.getGetEntityMessagesResult();
063        String componentVendorName = form.getComponentVendorName();
064        String entityTypeName = form.getEntityTypeName();
065        String messageTypeName = form.getMessageTypeName();
066        String messageName = form.getMessageName();
067        String entityRef = form.getEntityRef();
068        var parameterCount = (componentVendorName == null && entityTypeName == null && messageTypeName == null && messageName == null ? 0 : 1) + (entityRef == null ? 0 : 1);
069        
070        if(parameterCount == 1) {
071            var coreControl = getCoreControl();
072            var messageControl = Session.getModelController(MessageControl.class);
073            UserVisit userVisit = getUserVisit();
074            
075            if(entityRef != null) {
076                EntityInstance entityInstance = coreControl.getEntityInstanceByEntityRef(entityRef);
077                
078                if(entityInstance != null) {
079                    result.setEntityInstance(coreControl.getEntityInstanceTransfer(userVisit, entityInstance, false, false, false, false, false, false));
080                    result.setEntityMessages(messageControl.getEntityMessageTransfersByEntityInstance(userVisit, entityInstance));
081                } else {
082                    addExecutionError(ExecutionErrors.UnknownEntityRef.name(), entityRef);
083                }
084            } else {
085                ComponentVendor componentVendor = coreControl.getComponentVendorByName(componentVendorName);
086                
087                result.setComponentVendor(coreControl.getComponentVendorTransfer(userVisit, componentVendor));
088                
089                if(componentVendor != null) {
090                    EntityType entityType = coreControl.getEntityTypeByName(componentVendor, entityTypeName);
091                    
092                    result.setEntityType(coreControl.getEntityTypeTransfer(userVisit, entityType));
093                    
094                    if(entityType != null) {
095                        MessageType messageType = messageControl.getMessageTypeByName(entityType, messageTypeName);
096                        
097                        if(messageType != null) {
098                            Message message = messageControl.getMessageByName(messageType, messageName);
099                            
100                            result.setMessageType(messageControl.getMessageTypeTransfer(userVisit, messageType));
101                            
102                            if(message != null) {
103                                result.setMessage(messageControl.getMessageTransfer(userVisit, message));
104                                result.setEntityMessages(messageControl.getEntityMessageTransfersByMessage(userVisit, message));
105                            } else {
106                                addExecutionError(ExecutionErrors.UnknownMessageName.name(), messageName);
107                            }
108                        } else {
109                            addExecutionError(ExecutionErrors.UnknownMessageTypeName.name(), messageTypeName);
110                        }
111                    } else {
112                        addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), entityTypeName);
113                    }
114                } else {
115                    addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
116                }
117            }
118        } else {
119            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
120        }
121        
122        return result;
123    }
124    
125}