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.common;
018
019import com.echothree.control.user.message.common.form.*;
020import com.echothree.control.user.message.common.result.*;
021import com.echothree.model.data.user.common.pk.UserVisitPK;
022import com.echothree.util.common.command.CommandResult;
023import com.echothree.util.common.command.VoidResult;
024
025public interface MessageService
026        extends MessageForms {
027    
028    // -------------------------------------------------------------------------
029    //   Message Types
030    // -------------------------------------------------------------------------
031    
032    CommandResult<CreateMessageTypeResult> createMessageType(UserVisitPK userVisitPK, CreateMessageTypeForm form);
033    
034    CommandResult<GetMessageTypeResult> getMessageType(UserVisitPK userVisitPK, GetMessageTypeForm form);
035    
036    CommandResult<GetMessageTypesResult> getMessageTypes(UserVisitPK userVisitPK, GetMessageTypesForm form);
037    
038    CommandResult<EditMessageTypeResult> editMessageType(UserVisitPK userVisitPK, EditMessageTypeForm form);
039    
040    CommandResult<VoidResult> deleteMessageType(UserVisitPK userVisitPK, DeleteMessageTypeForm form);
041    
042    // -------------------------------------------------------------------------
043    //   Message Type Descriptions
044    // -------------------------------------------------------------------------
045    
046    CommandResult<VoidResult> createMessageTypeDescription(UserVisitPK userVisitPK, CreateMessageTypeDescriptionForm form);
047    
048    CommandResult<GetMessageTypeDescriptionsResult> getMessageTypeDescriptions(UserVisitPK userVisitPK, GetMessageTypeDescriptionsForm form);
049    
050    CommandResult<EditMessageTypeDescriptionResult> editMessageTypeDescription(UserVisitPK userVisitPK, EditMessageTypeDescriptionForm form);
051    
052    CommandResult<VoidResult> deleteMessageTypeDescription(UserVisitPK userVisitPK, DeleteMessageTypeDescriptionForm form);
053    
054    // -------------------------------------------------------------------------
055    //   Messages
056    // -------------------------------------------------------------------------
057    
058    CommandResult<VoidResult> createMessage(UserVisitPK userVisitPK, CreateMessageForm form);
059    
060    CommandResult<GetMessageResult> getMessage(UserVisitPK userVisitPK, GetMessageForm form);
061    
062    CommandResult<GetMessagesResult> getMessages(UserVisitPK userVisitPK, GetMessagesForm form);
063    
064    CommandResult<VoidResult> deleteMessage(UserVisitPK userVisitPK, DeleteMessageForm form);
065    
066    // -------------------------------------------------------------------------
067    //   Message Descriptions
068    // -------------------------------------------------------------------------
069    
070    CommandResult<VoidResult> createMessageDescription(UserVisitPK userVisitPK, CreateMessageDescriptionForm form);
071    
072    CommandResult<GetMessageDescriptionsResult> getMessageDescriptions(UserVisitPK userVisitPK, GetMessageDescriptionsForm form);
073    
074    CommandResult<EditMessageDescriptionResult> editMessageDescription(UserVisitPK userVisitPK, EditMessageDescriptionForm form);
075    
076    CommandResult<VoidResult> deleteMessageDescription(UserVisitPK userVisitPK, DeleteMessageDescriptionForm form);
077    
078    // -------------------------------------------------------------------------
079    //   Entity Messages
080    // -------------------------------------------------------------------------
081    
082    CommandResult<VoidResult> createEntityMessage(UserVisitPK userVisitPK, CreateEntityMessageForm form);
083    
084    CommandResult<GetEntityMessageResult> getEntityMessage(UserVisitPK userVisitPK, GetEntityMessageForm form);
085    
086    CommandResult<GetEntityMessagesResult> getEntityMessages(UserVisitPK userVisitPK, GetEntityMessagesForm form);
087    
088    CommandResult<VoidResult> deleteEntityMessage(UserVisitPK userVisitPK, DeleteEntityMessageForm form);
089    
090    // -------------------------------------------------------------------------
091    //   Testing
092    // -------------------------------------------------------------------------
093    
094    String ping();
095        
096}