SHOW Signed

net.rim.blackberry.api.mail
Class Store

java.lang.Object
  |
  +--net.rim.blackberry.api.mail.Service
        |
        +--net.rim.blackberry.api.mail.Store

public abstract class Store

extends Service

Represents a message store and its access protocol, for storing and retrieving messages on the handheld. You retrieve a Store instance by invoking Session.getStore().

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

See Also:

Folder

Method Summary

	void	addFolderListener(FolderListener l) Adds a folder listener to this store.
	void	addStoreListener(StoreListener l) Adds a store listener to this store.
	Folder[]	findFolder(String substring) Retrieves folders in this hierarchy that match the specified substring.
	Folder	getFolder(long folderId) Retrieves a Folder object by folder ID.
	Folder	getFolder(String name) Retrieves the Folder object corresponding to the given name.
	Folder[]	list() Retrieves a list of folders directly under this Store.
	Folder[]	list(int type) Retrieves the set of Folder objects that match the specified type.
	void	removeFolderListener(FolderListener l) Removes a folder listener from the root level.
	void	removeStoreListener(StoreListener l) Removes a store listener from this store.

Methods inherited from class net.rim.blackberry.api.mail.Service

getServiceConfiguration, isConnected, setConnected, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

list

public Folder[] list(int type)

Retrieves the set of Folder objects that match the specified type.

Parameters:

type - The type of folder for which to search.

Returns:

An array of folder objects matching the specified type, or an empty folder array if no folders match the specified type.

Since:

JDE 3.6

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getFolder

public Folder getFolder(long folderId)
                 throws FolderNotFoundException

Retrieves a Folder object by folder ID.

Parameters:

folderId - ID of the folder to get.

Returns:

A Folder object.

Throws:

FolderNotFoundException - when a folder with the specified name is not found

Since:

JDE 3.6

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getFolder

public Folder getFolder(String name)
                 throws FolderNotFoundException

Retrieves the Folder object corresponding to the given name.

This API does not support the following characters appearing in folder names:

• /
• :
• \

Parameters:

name - Name of the folder to get. The name must be an absolute path, starting with the hierarchy delimiter, but not ending with the delimiter. For example, "/abc/efg" is correct, where abc is a direct subfolder of this Store.

Returns:

A Folder object.

Throws:

FolderNotFoundException - Thrown when a folder with the specified name is not found.

Since:

JDE 3.6

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

findFolder

public Folder[] findFolder(String substring)

Retrieves folders in this hierarchy that match the specified substring.

Parameters:

substring - The simple substring to match.

Returns:

An array of folders matching the specified substring, or an empty folder array if no folder matches the specified substring.

Since:

JDE 3.6

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

list

public Folder[] list()

Retrieves a list of folders directly under this Store.

Returns:

An array of Folder objects or an empty array if no folders are present.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

addFolderListener

public void addFolderListener(FolderListener l)

Adds a folder listener to this store. The listener is invoked when FolderEvents occur on any folder in the store.

Parameters:

l - The FolderListener to add to this Store.

Since:

JDE 3.6

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

removeFolderListener

public void removeFolderListener(FolderListener l)

Removes a folder listener from the root level.

Parameters:

l - The FolderListener to remove from this Store.

Since:

JDE 3.6

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

addStoreListener

public void addStoreListener(StoreListener l)

Adds a store listener to this store.

Parameters:

l - StoreListener to add to this Store.

Since:

JDE 3.6

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

removeStoreListener

public void removeStoreListener(StoreListener l)

Removes a store listener from this store.

Parameters:

l - StoreListener to remove from this Store.

Since:

JDE 3.6

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.