dtw.webmail.model
Interface JwmaInboxInfo

All Known Implementing Classes:

JwmaFolderImpl

public interface JwmaInboxInfo

An interface defining the contract for interaction with the JwmaInboxInfo model.

The JwmaInboxInfo allows a view programmer to obtain information about the inbox; basically if there are new messages (and their count).

Version:

0.9.7 07/02/2003

Author:

Dieter Wimberger

Method Summary

int	getMessageCount() Returns an int representing the count of messages in the Inbox.
java.lang.String	getName() Returns a String representing the name of the Inbox.
int	getNewMessageCount() Returns an int representing the count of new messages in the Inbox.
java.lang.String	getPath() Returns a String representing the path of this folder object.
int	getUnreadMessageCount() Returns an int representing the count of unread messages in the Inbox.
boolean	hasNewMessages() Tests if the Inbox contains new messages.
boolean	hasUnreadMessages() Tests if the Inbox contains new messages, based on the flag for read messages.

Method Detail

getName

public java.lang.String getName()

Returns a String representing the name of the Inbox.

Returns:

the name of the Inbox as String.

getPath

public java.lang.String getPath()

Returns a String representing the path of this folder object.

Returns:

the path of the inbox as String.

getMessageCount

public int getMessageCount()

Returns an int representing the count of messages in the Inbox.

Note: method returns -1 if it fails to retrieve the actual messages count.

Returns:

the number of messages in this Inbox.

hasNewMessages

public boolean hasNewMessages()

Tests if the Inbox contains new messages.

Returns:

true if the Inbox contains new messages, false otherwise.

getNewMessageCount

public int getNewMessageCount()

Returns an int representing the count of new messages in the Inbox.

Note: method returns -1 if it fails to retrieve the actual new messages count.

Returns:

the number of new messages in the Inbox.

hasUnreadMessages

public boolean hasUnreadMessages()

Tests if the Inbox contains new messages, based on the flag for read messages.

Returns:

true if the Inbox contains unread messages, false otherwise.

getUnreadMessageCount

public int getUnreadMessageCount()

Returns an int representing the count of unread messages in the Inbox.

This method is based on the flag for read messages It returns -1 if it fails to retrieve the actual message count.

Returns:

the number of unread messages in the Inbox.