wt.lifecycle
Class LifeCycleServiceEvent

java.lang.Object
  wt.events.KeyedEvent
      wt.lifecycle.LifeCycleServiceEvent

All Implemented Interfaces:

Serializable

public class LifeCycleServiceEvent

extends KeyedEvent

implements Serializable

Provides a service specific event extended from KeyedEvent used in conjunction with the standard implementation of the server-side functionality as defined by the LifeCycleService interface. The event could be used by a custom implementation of the LifeCycleService.

Supported API: false

Extendable: false

See Also:

KeyedEvent, Serialized Form

Field Summary

static String	AUGMENT A constant that defines an event key that marks the occurrence of the augment Supported API: false
private static String	CLASSNAME
static String	DEMOTE A constant that defines an event key that marks the occurrence of the demote.
static String	DENY A constant that defines an event key that marks the occurrence of the deny.
static String	DISABLE_LIFECYCLE A constant that defines an event key that marks the occurrence of the disable of a Life Cycle Template Master Supported API: false
static String	DROP A constant that defines an event key that marks the occurrence of the drop.
static String	ENABLE_LIFECYCLE A constant that defines an event key that marks the occurrence of the enable of a Life Cycle Template Master Supported API: false
static String	PROMOTE A constant that defines an event key that marks the occurrence of the promote.
static String	REASSIGN A constant that defines an event key that marks the occurrence of the reassign.
private static String	RESOURCE
static String	ROLEHOLDER_CHANGE A constant that defines an event key that marks the occurrence of the ROLEHOLDER_CHANGE event of an object from lifecycle processing.
private LifeCycleService	service
static String	SET_STATE A constant that defines an event key that marks the occurrence of the set state Supported API: false
static String	STATE_CHANGE A constant that defines an event key that marks the occurrence of the promote or demote.
static String	SUBMIT A constant that defines an event key that marks the occurrence of the submit event.
static String	VOTE A constant that defines an event key that marks the occurrence of the vote event.

Fields inherited from class wt.events.KeyedEvent

Constructor Summary

LifeCycleServiceEvent(LifeCycleService service, String eventType, Object eventTarget)
Constructs a LifeCycle services event from the specified service and its event type and target.

LifeCycleServiceEvent(String eventType, Object eventTarget)
Constructs a single object LifeCycle services event from the event type and target.

LifeCycleServiceEvent(String eventType, WTCollection eventTarget)
Constructs a multi object LifeCycle services event from the event type and collection of target objects.

Method Summary

static String	generateEventKey(String eventType) Generates an event key from an event type.
LifeCycleService	getService() Gets the value of the attribute: service; The LifeCycle service that emits events.
LifeCycleManaged	getTarget() Gets the target of the event.
WTCollection	getTargets() Gets the collection of target objects of the event.
ObjectReference	getWfProcessReference() Gets the target of the event.

Methods inherited from class wt.events.KeyedEvent

generateEventKey, generateEventKey, getConceptualClassname, getEventKey, getEventTarget, getEventType, toMultiObjectEvent, toSingleObjectEvents, 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

STATE_CHANGE

public static final String STATE_CHANGE

A constant that defines an event key that marks the occurrence of the promote or demote.

Supported API: false

See Also:

Constant Field Values

ROLEHOLDER_CHANGE

public static final String ROLEHOLDER_CHANGE

A constant that defines an event key that marks the occurrence of the ROLEHOLDER_CHANGE event of an object from lifecycle processing.

Supported API: false

See Also:

Constant Field Values

ENABLE_LIFECYCLE

public static final String ENABLE_LIFECYCLE

A constant that defines an event key that marks the occurrence of the enable of a Life Cycle Template Master

Supported API: false

See Also:

Constant Field Values

DISABLE_LIFECYCLE

public static final String DISABLE_LIFECYCLE

A constant that defines an event key that marks the occurrence of the disable of a Life Cycle Template Master

Supported API: false

See Also:

Constant Field Values

service

private LifeCycleService service

SUBMIT

public static final String SUBMIT

A constant that defines an event key that marks the occurrence of the submit event.

Supported API: false

See Also:

Constant Field Values

PROMOTE

public static final String PROMOTE

A constant that defines an event key that marks the occurrence of the promote.

Supported API: false

See Also:

Constant Field Values

VOTE

public static final String VOTE

A constant that defines an event key that marks the occurrence of the vote event.

Supported API: false

See Also:

Constant Field Values

DEMOTE

public static final String DEMOTE

A constant that defines an event key that marks the occurrence of the demote.

Supported API: false

See Also:

Constant Field Values

DENY

public static final String DENY

A constant that defines an event key that marks the occurrence of the deny.

Supported API: false

See Also:

Constant Field Values

DROP

public static final String DROP

A constant that defines an event key that marks the occurrence of the drop.

Supported API: false

See Also:

Constant Field Values

REASSIGN

public static final String REASSIGN

A constant that defines an event key that marks the occurrence of the reassign.

Supported API: false

See Also:

Constant Field Values

AUGMENT

public static final String AUGMENT

A constant that defines an event key that marks the occurrence of the augment

Supported API: false

See Also:

Constant Field Values

SET_STATE

public static final String SET_STATE

A constant that defines an event key that marks the occurrence of the set state

Supported API: false

See Also:

Constant Field Values

Constructor Detail

LifeCycleServiceEvent

public LifeCycleServiceEvent(LifeCycleService service,
                             String eventType,
                             Object eventTarget)
                      throws LifeCycleException,
                             WTPropertyVetoException

Constructs a LifeCycle services event from the specified service and its event type and target.

Supported API: false

Parameters:

service - the LifeCycleService object used to construct the service's event

eventType - the type of event used to construct the service's event

eventTarget - the object used to construct the service's event

Throws:

LifeCycleException

WTPropertyVetoException

LifeCycleServiceEvent

public LifeCycleServiceEvent(String eventType,
                             Object eventTarget)
                      throws LifeCycleException,
                             WTPropertyVetoException

Constructs a single object LifeCycle services event from the event type and target.

Supported API: false

Parameters:

eventType - the type of event used to construct the service's event

eventTarget - the object used to construct the service's event

Throws:

LifeCycleException

WTPropertyVetoException

LifeCycleServiceEvent

public LifeCycleServiceEvent(String eventType,
                             WTCollection eventTarget)
                      throws LifeCycleException,
                             WTPropertyVetoException

Constructs a multi object LifeCycle services event from the event type and collection of target objects.

Supported API: false

Parameters:

eventType - the type of event used to construct the service's event

eventTarget - the object used to construct the service's event

Throws:

LifeCycleException

WTPropertyVetoException

Method Detail

getService

public LifeCycleService getService()

Gets the value of the attribute: service; The LifeCycle service that emits events.

Supported API: false

Returns:

LifeCycleService

generateEventKey

public static String generateEventKey(String eventType)

Generates an event key from an event type.

Supported API: false

Parameters:

eventType - the type of event used to generate an event key

Returns:

String

getTarget

public LifeCycleManaged getTarget()

Gets the target of the event.

Supported API: false

Returns:

LifeCycleManaged

See Also:

LifeCycleServiceEvent

getTargets

public WTCollection getTargets()

Gets the collection of target objects of the event.

Supported API: false

Returns:

WTCollection

See Also:

LifeCycleServiceEvent

getWfProcessReference

public ObjectReference getWfProcessReference()

Gets the target of the event.

Supported API: false

Returns:

ObjectReference

See Also:

LifeCycleServiceEvent