wt.eff
Class EffGroupAssistantEvent

java.lang.Object
  wt.events.KeyedEvent
      wt.eff.EffGroupAssistantEvent

All Implemented Interfaces:

Serializable

public class EffGroupAssistantEvent

extends KeyedEvent

implements Serializable

Events emitted by the EffGroupAssistant for customization purposes.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private EffGroup[]	effGroups
static String	POST_APPEND_EFF_GROUPS A constant that defines an event key that marks the occurrence of the pre-append (by the appendEffGroups API) event.
static String	POST_APPEND_EFF_VECTOR A constant that defines an event key that marks the occurrence of the post-append event.
static String	POST_REPLACE_EFF_VECTOR A constant that defines an event key that marks the occurrence of the post-replace event.
static String	PRE_APPEND_EFF_GROUPS A constant that defines an event key that marks the occurrence of the pre-append (by the appendEffGroups API) event.
static String	PRE_APPEND_EFF_VECTOR A constant that defines an event key that marks the occurrence of the pre-append event.
static String	PRE_REPLACE_EFF_VECTOR A constant that defines an event key that marks the occurrence of the pre-replace event.
private static String	RESOURCE

Fields inherited from class wt.events.KeyedEvent

Constructor Summary

EffGroupAssistantEvent(String eventType, EffManagedVersion[] effManagedVersions)


Supported API: false

EffGroupAssistantEvent(String eventType, EffManagedVersion[] effManagedVersions, EffGroup[] effGroups)


Supported API: false

EffGroupAssistantEvent(String eventKey, WTCollection effManagedVersions)


Supported API: false

EffGroupAssistantEvent(String eventKey, WTCollection effManagedVersions, EffGroup[] effGroups)


Supported API: false

Method Summary

static String	generateEventKey(String eventType)
EffGroup[]	getEffGroups() Gets the value of the attribute: effGroups; The groups (used only by the PRE/POST_APPEND_EFF_GROUPS events.
EffManagedVersion[]	getEffManagedVersions() Gets the value of the attribute: effManagedVersions; The target of the event.
WTCollection	getTargets() Returns WTCollection of EffManagedVersions.
KeyedEvent	toMultiObjectEvent() Given an event with a target object that is an array of EffManagedVersions return a KeyedEvent object with a target object that's a WTCollection of EffManagedVersions.
KeyedEvent[]	toSingleObjectEvents() Given an event with a target object that is a WTCollection of EffManagedVersions return a one-element array of KeyedEvent objects with a target object that's an array of EffManagedVersions.

Methods inherited from class wt.events.KeyedEvent

generateEventKey, generateEventKey, getConceptualClassname, getEventKey, getEventTarget, getEventType, toString

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

PRE_REPLACE_EFF_VECTOR

public static final String PRE_REPLACE_EFF_VECTOR

A constant that defines an event key that marks the occurrence of the pre-replace event.

Supported API: true

See Also:

Constant Field Values

POST_REPLACE_EFF_VECTOR

public static final String POST_REPLACE_EFF_VECTOR

A constant that defines an event key that marks the occurrence of the post-replace event.

Supported API: true

See Also:

Constant Field Values

PRE_APPEND_EFF_VECTOR

public static final String PRE_APPEND_EFF_VECTOR

A constant that defines an event key that marks the occurrence of the pre-append event.

Supported API: true

See Also:

Constant Field Values

POST_APPEND_EFF_VECTOR

public static final String POST_APPEND_EFF_VECTOR

A constant that defines an event key that marks the occurrence of the post-append event.

Supported API: true

See Also:

Constant Field Values

PRE_APPEND_EFF_GROUPS

public static final String PRE_APPEND_EFF_GROUPS

A constant that defines an event key that marks the occurrence of the pre-append (by the appendEffGroups API) event.

Supported API: true

See Also:

Constant Field Values

POST_APPEND_EFF_GROUPS

public static final String POST_APPEND_EFF_GROUPS

A constant that defines an event key that marks the occurrence of the pre-append (by the appendEffGroups API) event.

Supported API: true

See Also:

Constant Field Values

effGroups

private EffGroup[] effGroups

Constructor Detail

EffGroupAssistantEvent

public EffGroupAssistantEvent(String eventType,
                              EffManagedVersion[] effManagedVersions)

Supported API: false

Parameters:

eventType -

effManagedVersions -

EffGroupAssistantEvent

public EffGroupAssistantEvent(String eventType,
                              EffManagedVersion[] effManagedVersions,
                              EffGroup[] effGroups)

Supported API: false

Parameters:

eventType -

effManagedVersions -

effGroups -

EffGroupAssistantEvent

public EffGroupAssistantEvent(String eventKey,
                              WTCollection effManagedVersions)

Supported API: false

Parameters:

eventKey -

effManagedVersions -

EffGroupAssistantEvent

public EffGroupAssistantEvent(String eventKey,
                              WTCollection effManagedVersions,
                              EffGroup[] effGroups)

Supported API: false

Parameters:

eventKey -

effManagedVersions -

effGroups -

Method Detail

getEffManagedVersions

public EffManagedVersion[] getEffManagedVersions()

Gets the value of the attribute: effManagedVersions; The target of the event.

Supported API: true

Returns:

EffManagedVersion[]

getEffGroups

public EffGroup[] getEffGroups()

Gets the value of the attribute: effGroups; The groups (used only by the PRE/POST_APPEND_EFF_GROUPS events.

Supported API: true

Returns:

EffGroup[]

toSingleObjectEvents

public KeyedEvent[] toSingleObjectEvents()
                                  throws WTException

Given an event with a target object that is a WTCollection of EffManagedVersions return a one-element array of KeyedEvent objects with a target object that's an array of EffManagedVersions. Additionally, if the event has a non-null value for effGroups copy it forward.

Supported API: false

Overrides:

toSingleObjectEvents in class KeyedEvent

Returns:

KeyedEvent[]

Throws:

WTException

toMultiObjectEvent

public KeyedEvent toMultiObjectEvent()

Given an event with a target object that is an array of EffManagedVersions return a KeyedEvent object with a target object that's a WTCollection of EffManagedVersions. Additionally, if the event has a non-null value for effGroups copy it forward.

Supported API: false

Overrides:

toMultiObjectEvent in class KeyedEvent

Returns:

KeyedEvent

getTargets

public WTCollection getTargets()

Returns WTCollection of EffManagedVersions.

Supported API: false

Returns:

WTCollection

generateEventKey

public static String generateEventKey(String eventType)