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