Package wt.facade.persistedcollection

Class PersistedCollectionEvent

java.lang.Object

wt.events.KeyedEvent

wt.facade.persistedcollection.PersistedCollectionEvent

All Implemented Interfaces:

wt.events.summary.SummarizedEvent

public final class PersistedCollectionEvent
extends KeyedEvent

Used to represent events occurring within the PersistedCollection services. This event supports multiple object event targets. For most operations, the event target will either be a WTCollection of PersistedCollectionHolders or PersistedCollectables.

Supported API: true

Extendable: false

Field Summary

Fields

Modifier and Type	Field	Description
static final String	POST_ADD_MEMBERS	The event used to notify listeners that members have been added to a collection holder.
static final String	POST_ADD_SEEDS	The event used to notify listeners that seeds have been added to a collection holder.
static final String	POST_REMOVE_ALL_MEMBERS	The event used to notify listeners that all members have been removed from a collection holder.
static final String	POST_REMOVE_ALL_SEEDS	The event used to notify listeners that all seeds have been removed from a collection holder.
static final String	POST_REMOVE_MEMBERS	The event used to notify listeners that members have been removed from a collection holder.
static final String	POST_REMOVE_SEEDS	The event used to notify listeners that seeds have been removed from a collection holder.
static final String	PRE_ADD_MEMBERS	The event used to notify listeners that members are about to be added to a collection holder.
static final String	PRE_ADD_SEEDS	The event used to notify listeners that seeds are about to be added to a collection holder.
static final String	PRE_REMOVE_ALL_MEMBERS	The event used to notify listeners that all members are about to be removed from a collection holder.
static final String	PRE_REMOVE_ALL_SEEDS	The event used to notify listeners that all seeds are about to be removed from a collection holder.
static final String	PRE_REMOVE_MEMBERS	The event used to notify listeners that members are about to be removed from a collection holder.
static final String	PRE_REMOVE_SEEDS	The event used to notify listeners that seeds are about to be removed from a collection holder.

Method Summary

Modifier and Type	Method	Description
static String	generateEventKey(String eventType)	Generates an event key from an event type.
PersistedCollectionHolder	getHolder()	Gets the holder for the event.

Methods inherited from class wt.events.KeyedEvent

generateEventKey, getEventKey, getEventTarget, getEventType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

PRE_ADD_MEMBERS

public static final String PRE_ADD_MEMBERS

The event used to notify listeners that members are about to be added to a collection holder. The event target contains the added member objects. PersistedCollectionEvent.getHolder() returns the holder object.

Supported API: true

See Also:

• PersistedCollectionService.addMembers(wt.facade.persistedcollection.PersistedCollectionHolder, wt.fc.collections.WTCollection)
• Constant Field Values

POST_ADD_MEMBERS

public static final String POST_ADD_MEMBERS

The event used to notify listeners that members have been added to a collection holder. The event target contains the added member objects. PersistedCollectionEvent.getHolder() returns the holder object.

Supported API: true

See Also:

• PersistedCollectionService.addMembers(wt.facade.persistedcollection.PersistedCollectionHolder, wt.fc.collections.WTCollection)
• Constant Field Values

PRE_REMOVE_MEMBERS

public static final String PRE_REMOVE_MEMBERS

The event used to notify listeners that members are about to be removed from a collection holder. The event target contains collection of removed member objects. PersistedCollectionEvent.getHolder() returns the holder object.

Supported API: true

See Also:

• PersistedCollectionService.removeMembers(wt.facade.persistedcollection.PersistedCollectionHolder, wt.fc.collections.WTCollection)
• Constant Field Values

POST_REMOVE_MEMBERS

public static final String POST_REMOVE_MEMBERS

The event used to notify listeners that members have been removed from a collection holder. The event target contains collection of removed member objects. PersistedCollectionEvent.getHolder() returns the holder object.

Supported API: true

See Also:

• PersistedCollectionService.removeMembers(wt.facade.persistedcollection.PersistedCollectionHolder, wt.fc.collections.WTCollection)
• Constant Field Values

PRE_REMOVE_ALL_MEMBERS

public static final String PRE_REMOVE_ALL_MEMBERS

The event used to notify listeners that all members are about to be removed from a collection holder. The event target contains collection of holder objects.

Supported API: true

See Also:

• PersistedCollectionService.removeAllMembers(wt.facade.persistedcollection.PersistedCollectionHolder)
• Constant Field Values

POST_REMOVE_ALL_MEMBERS

public static final String POST_REMOVE_ALL_MEMBERS

The event used to notify listeners that all members have been removed from a collection holder. The event target contains collection of holder objects.

Supported API: true

See Also:

• PersistedCollectionService.removeAllMembers(wt.facade.persistedcollection.PersistedCollectionHolder)
• Constant Field Values

PRE_ADD_SEEDS

public static final String PRE_ADD_SEEDS

The event used to notify listeners that seeds are about to be added to a collection holder. The event target contains the added seed objects. PersistedCollectionEvent.getHolder() returns the holder object.

Supported API: true

See Also:

• PersistedCollectionService.addSeeds(wt.facade.persistedcollection.PersistedCollectionHolder, wt.fc.collections.WTCollection)
• Constant Field Values

POST_ADD_SEEDS

public static final String POST_ADD_SEEDS

The event used to notify listeners that seeds have been added to a collection holder. The event target contains the added seed objects. PersistedCollectionEvent.getHolder() returns the holder object.

Supported API: true

See Also:

• PersistedCollectionService.addSeeds(wt.facade.persistedcollection.PersistedCollectionHolder, wt.fc.collections.WTCollection)
• Constant Field Values

PRE_REMOVE_SEEDS

public static final String PRE_REMOVE_SEEDS

The event used to notify listeners that seeds are about to be removed from a collection holder. The event target contains collection of removed seed objects. PersistedCollectionEvent.getHolder() returns the holder object.

Supported API: true

See Also:

• PersistedCollectionService.removeSeeds(wt.facade.persistedcollection.PersistedCollectionHolder, wt.fc.collections.WTCollection)
• Constant Field Values

POST_REMOVE_SEEDS

public static final String POST_REMOVE_SEEDS

The event used to notify listeners that seeds have been removed from a collection holder. The event target contains collection of removed seed objects. PersistedCollectionEvent.getHolder() returns the holder object.

Supported API: true

See Also:

• PersistedCollectionService.removeSeeds(wt.facade.persistedcollection.PersistedCollectionHolder, wt.fc.collections.WTCollection)
• Constant Field Values

PRE_REMOVE_ALL_SEEDS

public static final String PRE_REMOVE_ALL_SEEDS

The event used to notify listeners that all seeds are about to be removed from a collection holder. The event target contains collection of holder objects.

Supported API: true

See Also:

• PersistedCollectionService.removeAllSeeds(wt.facade.persistedcollection.PersistedCollectionHolder)
• Constant Field Values

POST_REMOVE_ALL_SEEDS

public static final String POST_REMOVE_ALL_SEEDS

The event used to notify listeners that all seeds have been removed from a collection holder. The event target contains collection of holder objects.

Supported API: true

See Also:

• PersistedCollectionService.removeAllSeeds(wt.facade.persistedcollection.PersistedCollectionHolder)
• Constant Field Values

Method Details

generateEventKey

public static String generateEventKey(String eventType)

Generates an event key from an event type.

Supported API: true

Parameters:

eventType -

Returns:

String

getHolder

public PersistedCollectionHolder getHolder()

Gets the holder for the event.

Supported API: true

Returns:

PersistedCollectionHolder