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
072    /** Creates a new instance of GetEntityMessagesCommand */
073    public GetEntityMessagesCommand() {
074        super(null, FORM_FIELD_DEFINITIONS, true);
075    }
076
077    private EntityInstance entityInstance;
078    private Message message;
079
080    @Override
081    protected void handleForm() {
082        var componentVendorName = form.getComponentVendorName();
083        var entityTypeName = form.getEntityTypeName();
084        var messageTypeName = form.getMessageTypeName();
085        var messageName = form.getMessageName();
086        var entityRef = form.getEntityRef();
087        var parameterCount = (componentVendorName == null && entityTypeName == null && messageTypeName == null && messageName == null ? 0 : 1) + (entityRef == null ? 0 : 1);
088
089        if(parameterCount == 1) {
090            if(entityRef != null) {
091                entityInstance = entityInstanceLogic.getEntityInstanceByEntityRef(this, entityRef);
092            } else {
093                var entityType = entityTypeLogic.getEntityTypeByName(this, componentVendorName, entityTypeName);
094
095                if(!hasExecutionErrors()) {
096                    var messageType = messageControl.getMessageTypeByName(entityType, messageTypeName);
097
098                    if(messageType != null) {
099                        message = messageControl.getMessageByName(messageType, messageName);
100
101                        if(message == null) {
102                            addExecutionError(ExecutionErrors.UnknownMessageName.name(), messageTypeName, messageName);
103                        }
104                    } else {
105                        addExecutionError(ExecutionErrors.UnknownMessageTypeName.name(), messageTypeName);
106                    }
107                }
108            }
109        } else {
110            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
111        }
112    }
113
114    @Override
115    protected Long getTotalEntities() {
116        Long total = null;
117
118        if(!hasExecutionErrors()) {
119            if(entityInstance != null) {
120                total = messageControl.countEntityMessageByEntityInstance(entityInstance);
121            } else {
122                total = messageControl.countEntityMessageByMessage(message);
123            }
124        }
125
126        return total;
127    }
128
129    @Override
130    protected Collection<EntityMessage> getEntities() {
131        Collection<EntityMessage> entities = null;
132
133        if(!hasExecutionErrors()) {
134            if(entityInstance != null) {
135                entities = messageControl.getEntityMessagesByEntityInstance(entityInstance);
136            } else {
137                entities = messageControl.getEntityMessagesByMessage(message);
138            }
139        }
140
141        return entities;
142    }
143
144    @Override
145    protected BaseResult getResult(Collection<EntityMessage> entities) {
146        var result = MessageResultFactory.getGetEntityMessagesResult();
147
148        if(entities != null) {
149            var userVisit = getUserVisit();
150
151            if(entityInstance != null) {
152                result.setEntityInstance(entityInstanceControl.getEntityInstanceTransfer(userVisit, entityInstance, false, false, false, false));
153            } else {
154                result.setMessage(messageControl.getMessageTransfer(userVisit, message));
155            }
156
157            if(session.hasLimit(EntityMessageFactory.class)) {
158                result.setEntityMessageCount(getTotalEntities());
159            }
160
161            result.setEntityMessages(messageControl.getEntityMessageTransfers(userVisit, entities));
162        }
163
164        return result;
165    }
166
167}