wt.vc.sessioniteration
Class SessionIterationEvent

java.lang.Object
  wt.events.KeyedEvent
      wt.vc.sessioniteration.SessionIterationEvent

All Implemented Interfaces:

Serializable

public class SessionIterationEvent

extends KeyedEvent

implements Serializable

Events dispatched by the SessionIterationService during SessionIterationService.createSessionIteration(wt.vc.sessioniteration.SessionEditedIteration, wt.org.WTPrincipal, java.lang.String), SessionIterationService#{@link SessionIterationService#commitSessionIteraiton}, and deleteSessionIteration.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static String	POST_COMMIT_SESSION_ITERATION This constant identifies the event that is dispatched by SessionIterationService.commitSessionIteration(wt.vc.sessioniteration.SessionEditedIteration, java.lang.String) immediately after the session iteration is commited and has become the latest iteration on the predecessor's branch.
static String	POST_CREATE_SESSION_ITERATION This constant identifies the event that is dispatched by SessionIterationService.createSessionIteration(wt.vc.sessioniteration.SessionEditedIteration, wt.org.WTPrincipal, java.lang.String) immediately after the session iteration is stored.
static String	POST_DELETE_SESSION_ITERATION This constant identifies the event that is dispatched by SessionIterationService.deleteSessionIteration(wt.vc.sessioniteration.SessionEditedIteration) immediately after the session iteration is deleted.
static String	PRE_COMMIT_SESSION_ITERATION This constant identifies the event that is dispatched by SessionIterationService.commitSessionIteration(wt.vc.sessioniteration.SessionEditedIteration, java.lang.String) immediately before the session iteration is commited (to become the latest iteration on the predecessor's branch).
static String	PRE_CREATE_SESSION_ITERATION This constant identifies the event that is dispatched by SessionIterationService.createSessionIteration(wt.vc.sessioniteration.SessionEditedIteration, wt.org.WTPrincipal, java.lang.String) immediately before the session iteration is stored.
static String	PRE_DELETE_SESSION_ITERATION This constant identifies the event that is dispatched by SessionIterationService.deleteSessionIteration(wt.vc.sessioniteration.SessionEditedIteration) immediately before the session iteration is deleted.
private static String	RESOURCE

Fields inherited from class wt.events.KeyedEvent

Constructor Summary

SessionIterationEvent(String eventType, Object eventTarget)
Construct a Keyed Event.

SessionIterationEvent(String eventType, WTCollection eventTarget)


Supported API: false

Method Summary

static String	generateEventKey(String eventType) Generates an event key from an event type.
WTCollection	getTargetCollection() Supported API: false
KeyedEvent	toMultiObjectEvent() Supported API: false
KeyedEvent[]	toSingleObjectEvents() Supported API: false

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_CREATE_SESSION_ITERATION

public static final String PRE_CREATE_SESSION_ITERATION

This constant identifies the event that is dispatched by SessionIterationService.createSessionIteration(wt.vc.sessioniteration.SessionEditedIteration, wt.org.WTPrincipal, java.lang.String) immediately before the session iteration is stored. The target of this event is the new session iteration. To get the original iteration, call VersionControlService.predecessorOf(wt.vc.Iterated) API.

Supported API: true

See Also:

Constant Field Values

POST_CREATE_SESSION_ITERATION

public static final String POST_CREATE_SESSION_ITERATION

This constant identifies the event that is dispatched by SessionIterationService.createSessionIteration(wt.vc.sessioniteration.SessionEditedIteration, wt.org.WTPrincipal, java.lang.String) immediately after the session iteration is stored. The target of this event is the new session iteration. To get the original iteration, call VersionControlService.predecessorOf(wt.vc.Iterated) API.

Supported API: true

See Also:

Constant Field Values

PRE_COMMIT_SESSION_ITERATION

public static final String PRE_COMMIT_SESSION_ITERATION

This constant identifies the event that is dispatched by SessionIterationService.commitSessionIteration(wt.vc.sessioniteration.SessionEditedIteration, java.lang.String) immediately before the session iteration is commited (to become the latest iteration on the predecessor's branch). The target of this event is the new (succeeding) session iteration. To get the original iteration, call VersionControlService.predecessorOf(wt.vc.Iterated) API.

Supported API: true

See Also:

Constant Field Values

POST_COMMIT_SESSION_ITERATION

public static final String POST_COMMIT_SESSION_ITERATION

This constant identifies the event that is dispatched by SessionIterationService.commitSessionIteration(wt.vc.sessioniteration.SessionEditedIteration, java.lang.String) immediately after the session iteration is commited and has become the latest iteration on the predecessor's branch. The target of this event is the new (succeeding) session iteration. To get the original iteration, call VersionControlService.predecessorOf(wt.vc.Iterated) API.

Supported API: true

See Also:

Constant Field Values

PRE_DELETE_SESSION_ITERATION

public static final String PRE_DELETE_SESSION_ITERATION

This constant identifies the event that is dispatched by SessionIterationService.deleteSessionIteration(wt.vc.sessioniteration.SessionEditedIteration) immediately before the session iteration is deleted. The target of this event is the session iteration. To get the original iteration, call VersionControlService.predecessorOf(wt.vc.Iterated) API.

Supported API: true

See Also:

Constant Field Values

POST_DELETE_SESSION_ITERATION

public static final String POST_DELETE_SESSION_ITERATION

This constant identifies the event that is dispatched by SessionIterationService.deleteSessionIteration(wt.vc.sessioniteration.SessionEditedIteration) immediately after the session iteration is deleted. The target of this event is the deleted session iteration. To get the original iteration, call VersionControlService.predecessorOf(wt.vc.Iterated) API.

Supported API: true

See Also:

Constant Field Values

Constructor Detail

SessionIterationEvent

public SessionIterationEvent(String eventType,
                             Object eventTarget)

Construct a Keyed Event.

Supported API: false

Parameters:

eventType - The type of the event, may be null

eventTarget - The Primary target of the event, may be null

SessionIterationEvent

public SessionIterationEvent(String eventType,
                             WTCollection eventTarget)

Supported API: false

Parameters:

eventType -

eventTarget -

Method Detail

getTargetCollection

public WTCollection getTargetCollection()

Supported API: false

Returns:

WTCollection

generateEventKey

public static String generateEventKey(String eventType)

Generates an event key from an event type.

Supported API: false

Parameters:

eventType -

Returns:

String

toSingleObjectEvents

public KeyedEvent[] toSingleObjectEvents()
                                  throws WTException

Supported API: false

Overrides:

toSingleObjectEvents in class KeyedEvent

Returns:

KeyedEvent[]

Throws:

WTException

toMultiObjectEvent

public KeyedEvent toMultiObjectEvent()

Supported API: false

Overrides:

toMultiObjectEvent in class KeyedEvent

Returns:

KeyedEvent