SHOW Signed
 

net.rim.blackberry.api.mail.event
Class StoreEvent

java.lang.Object
  |
  +--net.rim.blackberry.api.mail.event.MailEvent
        |
        +--net.rim.blackberry.api.mail.event.StoreEvent

public class StoreEvent
extends MailEvent

Indicates that an event has occured on a specified store.

Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:
JDE 3.6.0

Field Summary
 Category: Signed static int BATCH_OPERATION
          Indicates that a batch operation has occurred on this store, such as a bulk delete or bulk add.
   
Constructor Summary
 Category: Signed StoreEvent(Store store, int type)
          Creates a new StoreEvent instance given the store and event type.
 
Method Summary
 Category: Signed  void dispatch(Object listener)
          Invokes the appropriate method on a listener for this event.
 Category: Signed  int getType()
          Returns the type of this event.
 Category: Signed  String toString()
          Retrieves string form of this mail event.
 
Methods inherited from class net.rim.blackberry.api.mail.event.MailEvent
getSource
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

BATCH_OPERATION

public static final int BATCH_OPERATION
Indicates that a batch operation has occurred on this store, such as a bulk delete or bulk add.

Users of the API should reconcile the state of all held Message instances, for instance, check for the Message.DELETED flag indicating the message has been deleted.

Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Constructor Detail

StoreEvent

public StoreEvent(Store store,
                  int type)
Creates a new StoreEvent instance given the store and event type.

Parameters:
store - The store that published this event.
type - Type of event, either MESSAGE_ADDED or MESSAGE_REMOVED.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Method Detail

dispatch

public void dispatch(Object listener)
Description copied from class: MailEvent
Invokes the appropriate method on a listener for this event.

Subclasses should override this method to provide specific functionality (that is, to dispatch to the appropriate method on the appropriate listener type).

Overrides:
dispatch in class MailEvent
Since:
JDE 3.6.0

Following copied from class: MailEvent
Parameters:
listener - Listener to handle this event.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

getType

public int getType()
Returns the type of this event.

Returns:
Either MESSAGE_ADDED or MESSAGE_REMOVED.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

toString

public String toString()
Description copied from class: MailEvent
Retrieves string form of this mail event.
Overrides:
toString in class MailEvent
Since:
JDE 4.0.0

Following copied from class: MailEvent
Returns:
Null; sub-classes should override this method to provide specific functionality.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.



Copyright 1999-2009 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.