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 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

Field Summary

static int

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

Constructor Summary

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

Method Summary

	void	dispatch(Object listener) Invokes the appropriate method on a listener for this event.
	int	getType() Returns the type of this event.
	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 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.

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 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.

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 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.

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 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.

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

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.