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.GetEntityMessagesForm;
020import com.echothree.control.user.message.common.result.MessageResultFactory;
021import com.echothree.model.control.core.server.control.EntityInstanceControl;
022import com.echothree.model.control.core.server.logic.ComponentVendorLogic;
023import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
024import com.echothree.model.control.core.server.logic.EntityTypeLogic;
025import com.echothree.model.control.message.server.control.MessageControl;
026import com.echothree.model.data.core.server.entity.EntityInstance;
027import com.echothree.model.data.message.server.entity.EntityMessage;
028import com.echothree.model.data.message.server.entity.Message;
029import com.echothree.model.data.message.server.factory.EntityMessageFactory;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
035import java.util.Collection;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetEntityMessagesCommand
042        extends BasePaginatedMultipleEntitiesCommand<EntityMessage, GetEntityMessagesForm> {
043    
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        FORM_FIELD_DEFINITIONS = List.of(
048            new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
049            new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, false, null, null),
050            new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, false, null, null),
051            new FieldDefinition("MessageTypeName", FieldType.ENTITY_NAME, false, null, null),
052            new FieldDefinition("MessageName", FieldType.TAG, false, null, null)
053        );
054    }
055    
056    @Inject
057    EntityInstanceControl entityInstanceControl;
058
059    @Inject
060    MessageControl messageControl;
061
062    @Inject
063    ComponentVendorLogic componentVendorLogic;
064
065    @Inject
066    EntityInstanceLogic entityInstanceLogic;
067
068    @Inject
069    EntityTypeLogic entityTypeLogic;
070
071    /** Creates a new instance of GetEntityMessagesCommand */
072    public GetEntityMessagesCommand() {
073        super(null, FORM_FIELD_DEFINITIONS, true);
074    }
075
076    private EntityInstance entityInstance;
077    private Message message;
078
079    @Override
080    protected void handleForm() {
081        var componentVendorName = form.getComponentVendorName();
082        var entityTypeName = form.getEntityTypeName();
083        var messageTypeName = form.getMessageTypeName();
084        var messageName = form.getMessageName();
085        var entityRef = form.getEntityRef();
086        var parameterCount = (componentVendorName == null && entityTypeName == null && messageTypeName == null && messageName == null ? 0 : 1) + (entityRef == null ? 0 : 1);
087
088        if(parameterCount == 1) {
089            if(entityRef != null) {
090                entityInstance = entityInstanceLogic.getEntityInstanceByEntityRef(this, entityRef);
091            } else {
092                var entityType = entityTypeLogic.getEntityTypeByName(this, componentVendorName, entityTypeName);
093
094                if(!hasExecutionErrors()) {
095                    var messageType = messageControl.getMessageTypeByName(entityType, messageTypeName);
096
097                    if(messageType != null) {
098                        message = messageControl.getMessageByName(messageType, messageName);
099
100                        if(message == null) {
101                            addExecutionError(ExecutionErrors.UnknownMessageName.name(), messageTypeName, messageName);
102                        }
103                    } else {
104                        addExecutionError(ExecutionErrors.UnknownMessageTypeName.name(), messageTypeName);
105                    }
106                }
107            }
108        } else {
109            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
110        }
111    }
112
113    @Override
114    protected Long getTotalEntities() {
115        Long total = null;
116
117        if(!hasExecutionErrors()) {
118            if(entityInstance != null) {
119                total = messageControl.countEntityMessageByEntityInstance(entityInstance);
120            } else {
121                total = messageControl.countEntityMessageByMessage(message);
122            }
123        }
124
125        return total;
126    }
127
128    @Override
129    protected Collection<EntityMessage> getEntities() {
130        Collection<EntityMessage> entities = null;
131
132        if(!hasExecutionErrors()) {
133            if(entityInstance != null) {
134                entities = messageControl.getEntityMessagesByEntityInstance(entityInstance);
135            } else {
136                entities = messageControl.getEntityMessagesByMessage(message);
137            }
138        }
139
140        return entities;
141    }
142
143    @Override
144    protected BaseResult getResult(Collection<EntityMessage> entities) {
145        var result = MessageResultFactory.getGetEntityMessagesResult();
146
147        if(entities != null) {
148            var userVisit = getUserVisit();
149
150            if(entityInstance != null) {
151                result.setEntityInstance(entityInstanceControl.getEntityInstanceTransfer(userVisit, entityInstance, false, false, false, false));
152            } else {
153                result.setMessage(messageControl.getMessageTransfer(userVisit, message));
154            }
155
156            if(session.hasLimit(EntityMessageFactory.class)) {
157                result.setEntityMessageCount(getTotalEntities());
158            }
159
160            result.setEntityMessages(messageControl.getEntityMessageTransfers(userVisit, entities));
161        }
162
163        return result;
164    }
165
166}