| dtw.webmail.model.JwmaFolder
All known Subclasses: dtw.webmail.model.JwmaFolderImpl,
| JwmaFolder | | public interface JwmaFolder (Code) | | An interface defining the contract for interaction with
the JwmaFolder model.
The JwmaFolder allows a view programmer to obtain
information about a folder.
author:
Dieter Wimberger
version:
0.9.7 07/02/2003 |
| Field Summary | |
| final public static int | TYPE_ALL
Defines a virtual type that represents all of the above. | | final public static int | TYPE_FOLDER
Defines folder type that can only hold folders. | | final public static int | TYPE_FOLDER_CONTAINER
Defines a virtual type that represents all folders that can
hold folders. | | final public static int | TYPE_MAILBOX
Defines folder type that can only hold messages. | | final public static int | TYPE_MESSAGE_CONTAINER
Defines a virtual type that represents all folders that
can hold messages. | | final public static int | TYPE_MIXED
Defines folder type that can hold messages and folders. |
| Method Summary | |
| public String | getName()
Returns a String representing the name
of this folder. | | public String | getPath()
Returns a String representing the path
of this folder object. | | public int | getType()
Returns an int representing the type
of this folder. | | public boolean | hasMessages()
Tests if this folder object contains messages. | | public boolean | hasSubfolders()
Tests if this folder contains subfolders. | | public boolean | isSubscribed()
Tests if this folder is subscribed. | | public boolean | isType(int type)
Tests if this folder is of a given type. | | public JwmaMessageInfo[] | listMessageInfos()
Returns a JwmaMessageInfo[].
If this folder does not contain any messages, then this
method returns an empty array. | | public JwmaFolder[] | listSubfolders(int type, boolean subscribed)
Returns aJwmaFolder[] containing all subfolders of
the given type within this folder, observing subscription.
If the store does not contain any matching folder, then this
method returns an empty array. | | public JwmaFolder[] | listSubfolders(int type)
Returns aJwmaFolder[] containing all subfolders of
the given type within this folder.
If the store does not contain any matching folder, then this
method returns an empty array. | | public JwmaFolder[] | listSubfolders()
Convenience method that returns aJwmaFolder[]
containing all subfolders within this folder.
If this folder does not contain any subfolder, then this
method returns an empty array. |
| TYPE_ALL | | final public static int TYPE_ALL(Code) | | Defines a virtual type that represents all of the above.
|
| TYPE_FOLDER | | final public static int TYPE_FOLDER(Code) | | Defines folder type that can only hold folders.
|
| TYPE_FOLDER_CONTAINER | | final public static int TYPE_FOLDER_CONTAINER(Code) | | Defines a virtual type that represents all folders that can
hold folders.
|
| TYPE_MAILBOX | | final public static int TYPE_MAILBOX(Code) | | Defines folder type that can only hold messages.
|
| TYPE_MESSAGE_CONTAINER | | final public static int TYPE_MESSAGE_CONTAINER(Code) | | Defines a virtual type that represents all folders that
can hold messages.
|
| TYPE_MIXED | | final public static int TYPE_MIXED(Code) | | Defines folder type that can hold messages and folders.
|
| getName | | public String getName()(Code) | | Returns a String representing the name
of this folder.
the name of this folder as String. |
| getPath | | public String getPath()(Code) | | Returns a String representing the path
of this folder object.
the path of this folder as String. |
| getType | | public int getType()(Code) | | Returns an int representing the type
of this folder.
the type of this folder object as int. |
| hasMessages | | public boolean hasMessages()(Code) | | Tests if this folder object contains messages.
true if this folder contains messages, false otherwise. |
| hasSubfolders | | public boolean hasSubfolders()(Code) | | Tests if this folder contains subfolders.
true if this folder contains subfolders, false otherwise. |
| isSubscribed | | public boolean isSubscribed()(Code) | | Tests if this folder is subscribed.
true if subscribed, false otherwise. |
| isType | | public boolean isType(int type)(Code) | | Tests if this folder is of a given type.
true if this folder is of the given type, false otherwise. |
| listMessageInfos | | public JwmaMessageInfo[] listMessageInfos()(Code) | | Returns a JwmaMessageInfo[].
If this folder does not contain any messages, then this
method returns an empty array. Otherwise it contains
one JwmaMessageInfo instance for each message
in this folder, encapsulating all necessary information
for list displaying of the message.
a JwmaMessageInfo[] containing a info instancefor each message in this folder. The array will be empty ifthere are no messages in this folder.
See Also: dtw.webmail.model.JwmaMessageInfo |
| listSubfolders | | public JwmaFolder[] listSubfolders(int type, boolean subscribed)(Code) | | Returns aJwmaFolder[] containing all subfolders of
the given type within this folder, observing subscription.
If the store does not contain any matching folder, then this
method returns an empty array. Otherwise it contains
one JwmaFolder for each subfolder of the given type.
a JwmaFolder[] containing all subfolders ofthe given type within this folder. The array will beempty if there are none. |
| listSubfolders | | public JwmaFolder[] listSubfolders(int type)(Code) | | Returns aJwmaFolder[] containing all subfolders of
the given type within this folder.
If the store does not contain any matching folder, then this
method returns an empty array. Otherwise it contains
one JwmaFolder for each subfolder of the given type.
a JwmaFolder[] containing all subfolders ofthe given type within this folder. The array will beempty if there are none. |
| listSubfolders | | public JwmaFolder[] listSubfolders()(Code) | | Convenience method that returns aJwmaFolder[]
containing all subfolders within this folder.
If this folder does not contain any subfolder, then this
method returns an empty array. Otherwise it contains
one JwmaFolder for each subfolder.
a JwmaFolder[] containing all subfolders ofthis folder. The array will be empty if there are none. |
|
|