org.jasig.portlet.emailpreview
Class AccountInfo

java.lang.Object
  org.jasig.portlet.emailpreview.AccountInfo

public class AccountInfo
extends Object

An entity object that abstracts the email account information of a user. Currently, all the information retrieved is related to the user's inbox.

Version:

$Revision: 20509 $

Author:

Andreas Christoforides, Jen Bourey, jbourey@unicon.net

Constructor Summary

AccountInfo()

Method Summary

List<EmailMessage>	getMessages() Returns a list that contains a certain number of the most recent unread emails in the user's inbox.
int	getTotalMessageCount() Returns the number of total messages in the user's inbox.
int	getUnreadMessageCount() Returns the number of unread messages in the user's inbox.
void	setMessages(List<EmailMessage> unreadMessages) Sets a list that contains a certain number of the most recent unread emails in the user's inbox.
void	setTotalMessageCount(int totalMessagecount) Sets the number of total messages in the user's inbox.
void	setUnreadMessageCount(int unreadMessageCount) Sets the number of unread messages in the user's inbox.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountInfo

public AccountInfo()

Method Detail

getUnreadMessageCount

public int getUnreadMessageCount()

Returns the number of unread messages in the user's inbox. The number of unread messages is bounded by the inspectedMessageCount attribute.

Returns:

The number of unread messages in the user's inbox.

setUnreadMessageCount

public void setUnreadMessageCount(int unreadMessageCount)

Sets the number of unread messages in the user's inbox. The number of unread messages is bounded by the inspectedMessageCount attribute.

Parameters:

unreadMessageCount - The number of unread messages in the user's inbox.

getMessages

public List<EmailMessage> getMessages()

Returns a list that contains a certain number of the most recent unread emails in the user's inbox. The number of unread messages is controlled by a property in mail.properties.

Returns:

A List containing information about the most recent unread emails in the user's inbox.

setMessages

public void setMessages(List<EmailMessage> unreadMessages)

Sets a list that contains a certain number of the most recent unread emails in the user's inbox. The number of unread messages is controlled by a property in mail.properties.

Parameters:

unreadMessages - A List containing information about the most recent unread emails in the user's inbox.

getTotalMessageCount

public int getTotalMessageCount()

Returns the number of total messages in the user's inbox. The number is not bounded by the value of the inspectedMessageCount attribute.

Returns:

The total number of messages in the user's inbox.

setTotalMessageCount

public void setTotalMessageCount(int totalMessagecount)

Sets the number of total messages in the user's inbox. The number is not bounded by the value of the inspectedMessageCount attribute.

Parameters:

totalMessagecount - The number of total messages in the user's inbox.