dtw.webmail.model
Interface JwmaStoreInfo

All Known Implementing Classes:

JwmaStoreImpl

public interface JwmaStoreInfo

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

The JwmaStoreInfo allows a view programmer to obtain information regarding the mail store (such as the mode, the folder separator in use etc.).

Version:

0.9.7 07/02/2003

Author:

Dieter Wimberger

Method Summary

char	getFolderSeparator() Returns the folder separator in use as char.
boolean	isMixedMode() Tests if the store can hold mixed mode folders.
JwmaFolder[]	listFolderMoveTargets() Returns a JwmaFolder[] containing all folders of the store, that can hold folders, excluding this folder.
JwmaFolder[]	listFolders(int type) Returns a JwmaFolder[] containing all folders on the store of a given type.
JwmaFolder[]	listFolders(int type, boolean subscribed) Returns a JwmaFolder[] containing all folders on the store of a given type.
JwmaFolder[]	listMessageMoveTargets() Returns a JwmaFolder[] containing all folders of the store, that can hold messages, excluding this folder.

Method Detail

isMixedMode

public boolean isMixedMode()

Tests if the store can hold mixed mode folders.

Returns:

true if it can hold mixed mode folders, false otherwise.

getFolderSeparator

public char getFolderSeparator()

Returns the folder separator in use as char.

Returns:

the folder separator character.

listFolders

public JwmaFolder[] listFolders(int type)

Returns a JwmaFolder[] containing all folders on the store of a given type.

If the store does not contain any folders of the given type, then this method returns an empty array. Otherwise it contains one JwmaFolder for each folder on the store of the given type.

Returns:

a JwmaFolder[] naming all folders of given type on the store. The array will be empty if there are no such folders.

See Also:

JwmaFolder

listFolders

public JwmaFolder[] listFolders(int type,
                                boolean subscribed)

Returns a JwmaFolder[] containing all folders on the store of a given type. Note that this method will observe subscription if the passed in parameter is true.

If the store does not contain any folders of the given type, then this method returns an empty array. Otherwise it contains one JwmaFolder for each folder on the store of the given type.

Parameters:

type - the type of folder as int.

subscribed - true if observe subscription, false otherwise.

Returns:

a JwmaFolder[] naming all folders of given type on the store. The array will be empty if there are no such folders.

See Also:

JwmaFolder

listFolderMoveTargets

public JwmaFolder[] listFolderMoveTargets()

Returns a JwmaFolder[] containing all folders of the store, that can hold folders, excluding this folder.

If the store does not contain any folders, then this method returns an empty array (which means something is wrong!;). Otherwise it contains one JwmaFolder for each folder on the store, excluding this folder.

Returns:

a JwmaFolder[] containing all folders in the store that can hold folders, excluding this one. The array will be empty if there are no such folders.

See Also:

JwmaFolder

listMessageMoveTargets

public JwmaFolder[] listMessageMoveTargets()

Returns a JwmaFolder[] containing all folders of the store, that can hold messages, excluding this folder.

If the store does not contain any folders, then this method returns an empty array (which means something is wrong!;). Otherwise it contains one JwmaFolder for each folder on the store, excluding this folder.

Returns:

a JwmaFolder[] containing all folders in the store that can hold messages, excluding this one. The array will be empty if there are no such folders.

See Also:

JwmaFolder