Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
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.

Invoke Session.getStore() to retrieve a Store instance.

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.

Since:
JDE 3.6.0
See Also:
Folder

Method Summary
 Category: Signed  void addFolderListener(FolderListener l)
          Adds a folder listener to this store.
 Category: Signed  void addStoreListener(StoreListener l)
          Adds a store listener to this store.
 Category: Signed  boolean equals(Object o)
          Compares another store object to this instance.
 Category: Signed  Folder[] findFolder(String substring)
          Retrieves folders in this store that match the provided substring.
 Category: Signed  Folder getFolder(long folderId)
          Retrieves a folder by ID.
 Category: Signed  Folder getFolder(String name)
          Retrieves a folder by name.
 Category: Signed static Message getMessage(int id)
          Retrieves a message by ID from all the stores in the system.
 Category: Signed  Folder[] list()
          Retrieves a list of folders directly under this Store.
 Category: Signed  Folder[] list(int type)
          Retrieves the set of folders directly under this store that match provided type.
 Category: Signed  void removeFolderListener(FolderListener l)
          Removes a folder listener from the root level.
 Category: Signed  void removeStoreListener(StoreListener l)
          Removes a store listener from this store.
 
Methods inherited from class net.rim.blackberry.api.mail.Service
addServiceListener, getServiceConfiguration, isConnected, removeServiceListener, setConnected, toString
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

list

public Folder[] list(int type)
Retrieves the set of folders directly under this store that match provided type.
Parameters:
type - Type of folder(s) to retrieve.
Returns:
List of folders matching your type, or an empty array if no folders match your type.
Since:
JDE 4.0.2
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 by ID.
Parameters:
folderId - ID of the folder to retrieve.
Returns:
Folder with provided ID.
Throws:
FolderNotFoundException - If no folder exists with provided ID.
Since:
JDE 4.0.2
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 a folder by name.

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

  • /
  • :
  • \
Parameters:
name - Name of the folder to retrieve. 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:
Folder with provided absolute name.
Throws:
FolderNotFoundException - If no folder exists with provided name.
Since:
JDE 4.0.2
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 store that match the provided substring.
Parameters:
substring - Substring to match against folder names.
Returns:
List of folders in this store with names matching the provided substring, or an empty array if no folders exist that match.
Since:
JDE 4.0.2
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.
Since:
JDE 3.6.0
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 4.0.2
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 4.0.2
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 4.0.2
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 4.0.2
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.

equals

public boolean equals(Object o)
Compares another store object to this instance.

Store instances are equal if they are represented by the same ServiceConfiguration object.

Overrides:
equals in class Object
Parameters:
o - The object to compare this store to.
Since:
JDE 4.0.2
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.

getMessage

public static Message getMessage(int id)
Retrieves a message by ID from all the stores in the system.
Parameters:
id - ID for the message to retrieve.
Returns:
Message associated with your ID, or null if no such message exists or if your ID is 0.
Since:
JDE 4.0.2
See Also:
Message.getMessageId()
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.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

Copyright 1999-2004 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.