org.jbei.ice.lib.message

Class Messages

java.lang.Object

org.jbei.ice.lib.message.Messages

public class Messages
extends Object

Author:

Hector Plahar

Constructor Summary

Constructors

Constructor and Description
Messages(String userId)

Method Summary

Modifier and Type	Method and Description
Results<MessageInfo>	get(int start, int limit)
MessageInfo	get(long id)
int	getNewMessageCount(Account account)
int	markMessageAsRead(long id) Marks a message as read and returns the number of unread messages
boolean	send(MessageInfo info) Sends message contained in the MessageInfo to the specified recipients.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Messages

public Messages(String userId)

Method Detail

markMessageAsRead

public int markMessageAsRead(long id)

Marks a message as read and returns the number of unread messages

Parameters:

id - identifier for message to be marked as read

Returns:

number of unread messages after marking message as read

send

public boolean send(MessageInfo info)

Sends message contained in the MessageInfo to the specified recipients. It some of the recipients do not exist, the routine does its best to deliver as many as possible

Parameters:

info - details of message including recipient(s)

Returns:

false if the message fails to be sent to all the intended recipients

get

public Results<MessageInfo> get(int start,
                                int limit)

get

public MessageInfo get(long id)

getNewMessageCount

public int getNewMessageCount(Account account)