com.oss.teamshare.messaging

Interface Mailbox

public interface Mailbox

Represents a user's mailbox, a repository-type element, providing the set of Message objects sent or received by an user. It's an interface that hides the actual storage of objects. It's not responsible for the retrieval of messages.

Method Summary

Methods

Modifier and Type	Method and Description
void	addMessage(Message msg) Adds a new message to the mailbox.
void	addMessages(Collection<Message> messages) Adds newly received or sent messages to the mailbox.
void	checkForMessages() Triggers a check for new message and updates on existing message.
Collection<Message>	getMessages(MessageQuery query) Returns a list of messages of the logged-in user based on the given query criteria.
void	removeMessage(Message msg) Removes (deletes) a message from the mailbox.
void	updateMessageStatus(Message msg, MessageStatus newStatus) Updates the message's status (read/unread), see also MessageStatus

Method Detail

getMessages

Collection<Message> getMessages(MessageQuery query)

Returns a list of messages of the logged-in user based on the given query criteria.

Parameters:

query - - filtering constraints for the list of messages (certain interval, certain destination etc)

Returns:

a list of Message objects

addMessage

void addMessage(Message msg)

Adds a new message to the mailbox.

addMessages

void addMessages(Collection<Message> messages)

Adds newly received or sent messages to the mailbox.

removeMessage

void removeMessage(Message msg)

Removes (deletes) a message from the mailbox.

Parameters:

msg - - the message to be deleted

updateMessageStatus

void updateMessageStatus(Message msg,
                       MessageStatus newStatus)

Updates the message's status (read/unread), see also MessageStatus

Parameters:

msg - - the message whose status to updated

newStatus - - the message's new status

checkForMessages

void checkForMessages()

Triggers a check for new message and updates on existing message. The actual retrieval(pull) of messages must be done in a different component, such as MessagingService.