wt.occurrence
Class OccurrenceEvent

java.lang.Object
  wt.events.KeyedEvent
      wt.occurrence.OccurrenceEvent

All Implemented Interfaces:

Serializable

public class OccurrenceEvent

extends KeyedEvent

implements Serializable

This event is emitted by the StandardOccurrenceService.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static String	COPY_USES_OCCURRENCE A constant that defines an event marking the occurrance of copying a UsesOccurrence that is about to commense.
private Object	original
private static String	RESOURCE

Fields inherited from class wt.events.KeyedEvent

Constructor Summary

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

OccurrenceEvent(String eventType, WTKeyedMap eventTarget)
Construct Multi Object Keyed Event.

Method Summary

static String	generateEventKey(String eventType) Generates an event key from an event type.
Object	getOriginal() Gets the value of the attribute: original; The primary target of this event.
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

COPY_USES_OCCURRENCE

public static final String COPY_USES_OCCURRENCE

A constant that defines an event marking the occurrance of copying a UsesOccurrence that is about to commense. Listener's of this event can stipulate that preconditions have not been satisfied by means of throwing an exception which acts as a veto.

Supported API: true

See Also:

Constant Field Values

original

private Object original

Constructor Detail

OccurrenceEvent

public OccurrenceEvent(String eventType,
                       Object eventTarget,
                       Object original)

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

original -

OccurrenceEvent

public OccurrenceEvent(String eventType,
                       WTKeyedMap eventTarget)

Construct Multi Object Keyed Event. This constructor takes WTMap where key is eventTarget and the value is original

Supported API: false

Parameters:

eventType - The type of the event, may be null

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

Method Detail

getOriginal

public Object getOriginal()

Gets the value of the attribute: original; The primary target of this event. May be null.

Supported API: false

Returns:

Object

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