org.cyclos.services.messaging

Interface MessageService

All Superinterfaces:

Service

public interface MessageService
extends Service

Service used to manage messages between users

Author:

glauber

Method Summary

Modifier and Type	Method and Description
int	countNewMessages() Return messages count since the last time seen
int	countUnreadMessages() Return unread messages count
MessageData	getData(@NotNull java.lang.Long id) Returns details data for the given message
MessageSearchData	getSearchData() Returns data used to search messages
SendMessageData	getSendData(java.lang.Long replyId, UserLocatorVO toUser) Returns data for sending a message.
SendInviteMessageData	getSendInviteMessageData() Returns data for sending an invite message
void	markAsRead(@NotNull java.util.Set<java.lang.Long> ids, boolean isRead) Marks all the given message as either read or as unread
void	moveToTrash(@NotNull java.util.Set<java.lang.Long> ids) Moves all the given messages to the trash bin
void	removeAll(@NotNull java.util.Set<java.lang.Long> ids) Permanently removes all the given messages
void	restoreAll(@NotNull java.util.Set<java.lang.Long> ids) Restores the given messages, that is, move them from the trash bin to the original message box (either inbox or sent items)
Page<MessageVO>	search(@NotNull MessageQuery query) Searches for messages according to the given criteria
void	send(@NotNull SendMessageDTO object) Sends a message
void	sendInviteMessage(@NotNull SendInviteMessageDTO inviteMessageDTO) Sends an invitation message to the destination addresses

Method Detail

countNewMessages

int countNewMessages()
              throws FrameworkException

Return messages count since the last time seen

Throws:

FrameworkException

countUnreadMessages

int countUnreadMessages()
                 throws FrameworkException

Return unread messages count

Throws:

FrameworkException

getData

MessageData getData(@NotNull
                    @NotNull java.lang.Long id)
             throws FrameworkException

Returns details data for the given message

Throws:

FrameworkException

getSearchData

MessageSearchData getSearchData()
                         throws FrameworkException

Returns data used to search messages

Throws:

FrameworkException

getSendData

SendMessageData getSendData(java.lang.Long replyId,
                            UserLocatorVO toUser)
                     throws FrameworkException

Returns data for sending a message. If replyId is given, the new message will be a reply for that one. If toUser is given, the message will be to that specific user.

Throws:

FrameworkException

getSendInviteMessageData

SendInviteMessageData getSendInviteMessageData()

Returns data for sending an invite message

markAsRead

void markAsRead(@NotNull
                @NotNull java.util.Set<java.lang.Long> ids,
                boolean isRead)
         throws FrameworkException

Marks all the given message as either read or as unread

Throws:

FrameworkException

moveToTrash

void moveToTrash(@NotNull
                 @NotNull java.util.Set<java.lang.Long> ids)
          throws FrameworkException

Moves all the given messages to the trash bin

Throws:

FrameworkException

removeAll

void removeAll(@NotNull
               @NotNull java.util.Set<java.lang.Long> ids)
        throws FrameworkException

Permanently removes all the given messages

Throws:

FrameworkException

restoreAll

void restoreAll(@NotNull
                @NotNull java.util.Set<java.lang.Long> ids)
         throws FrameworkException

Restores the given messages, that is, move them from the trash bin to the original message box (either inbox or sent items)

Throws:

FrameworkException

search

Page<MessageVO> search(@NotNull
                       @NotNull MessageQuery query)
                throws FrameworkException

Searches for messages according to the given criteria

Throws:

FrameworkException

send

void send(@NotNull
          @NotNull SendMessageDTO object)
   throws FrameworkException

Sends a message

Throws:

FrameworkException

sendInviteMessage

void sendInviteMessage(@NotNull
                       @NotNull SendInviteMessageDTO inviteMessageDTO)

Sends an invitation message to the destination addresses