com.tibco.xp.runtime

Class Event

java.lang.Object

com.tibco.xp.runtime.Entity

com.tibco.xp.runtime.Event

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

NonTransient, Timed, Transient

public abstract class Event
extends Entity

Event base class

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.Boolean	_DEFAULT_RETRY_ON_EXCEPTION
protected static java.lang.Long	_DEFAULT_TIME_TO_LIVE
protected static java.lang.String	_INVALID_TIMER_IDENTIFIER
protected static java.lang.String	_TIME_TO_LIVE_UNITS_DEFAULT
static java.lang.String	TIME_TO_LIVE_UNITS_DAYS TimeToLiveUnits value, in days.
static java.lang.String	TIME_TO_LIVE_UNITS_HOURS TimeToLiveUnits value, in hours.
static java.lang.String	TIME_TO_LIVE_UNITS_MILLISECONDS TimeToLiveUnits value, in milliseconds.
static java.lang.String	TIME_TO_LIVE_UNITS_MINUTES TimeToLiveUnits value, in minutes.
static java.lang.String	TIME_TO_LIVE_UNITS_SECONDS TimeToLiveUnits value, in seconds.

Fields inherited from class com.tibco.xp.runtime.Entity

INVALID_TYPE_IDENTIFIER

Constructor Summary

Constructors

Constructor and Description
Event()

Method Summary

Modifier and Type	Method and Description
protected void	assertEvent() Assert an event.
abstract void	delete() Delete this event
protected void	enforceDispatchState() Enforce that setters cannot change fields once event has been asserted
void	generate() Deprecated.
abstract java.lang.String	getDestination() Get the event destination
protected abstract java.lang.Boolean	getDispatched() Get the current dispatch state
java.lang.String	getPayload() Deprecated.
abstract PayLoad	getPayLoad() Get the event payload
abstract java.lang.Boolean	getRetryOnException() Get the retry-on-exception value for this event.
abstract java.lang.Long	getTimeToLive() Get the Time-To-Live value for this event.
abstract java.lang.String	getTimeToLiveUnits() Get the Time-To-Live units for this event.
abstract void	setDestination(java.lang.String destination) Set the event destination
protected abstract void	setDispatched() Set dispatched to true
void	setPayLoad(PayLoad payload) Set the event payload.
void	setPayload(java.lang.String payload) Deprecated.
protected abstract void	setRetryOnException(java.lang.Boolean retryOnException) Set retry on exception
protected abstract void	setTimeToLive(java.lang.Long timeToLive) Set the time to live for this event
protected abstract void	setTimeToLiveUnits(java.lang.String timeToLiveUnits) Set time to live units
java.lang.String	toString()
protected abstract void	updatePayLoad(PayLoad payload) Update the internal payload
protected abstract void	updateProperties() Update event handle properties from shared memory

Methods inherited from class com.tibco.xp.runtime.Entity

assertEntity, checkActive, getExtId, getHandle, getHandle, getId, load, mapArray, mapHandle, mapHandleArray, register

Methods inherited from class java.lang.Object

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

Field Detail

TIME_TO_LIVE_UNITS_DAYS

public static final java.lang.String TIME_TO_LIVE_UNITS_DAYS

TimeToLiveUnits value, in days.

See Also:

Constant Field Values

TIME_TO_LIVE_UNITS_HOURS

public static final java.lang.String TIME_TO_LIVE_UNITS_HOURS

TimeToLiveUnits value, in hours.

See Also:

Constant Field Values

TIME_TO_LIVE_UNITS_MINUTES

public static final java.lang.String TIME_TO_LIVE_UNITS_MINUTES

TimeToLiveUnits value, in minutes.

See Also:

Constant Field Values

TIME_TO_LIVE_UNITS_SECONDS

public static final java.lang.String TIME_TO_LIVE_UNITS_SECONDS

TimeToLiveUnits value, in seconds.

See Also:

Constant Field Values

TIME_TO_LIVE_UNITS_MILLISECONDS

public static final java.lang.String TIME_TO_LIVE_UNITS_MILLISECONDS

TimeToLiveUnits value, in milliseconds.

See Also:

Constant Field Values

_DEFAULT_RETRY_ON_EXCEPTION

protected static final java.lang.Boolean _DEFAULT_RETRY_ON_EXCEPTION

_INVALID_TIMER_IDENTIFIER

protected static final java.lang.String _INVALID_TIMER_IDENTIFIER

See Also:

Constant Field Values

_DEFAULT_TIME_TO_LIVE

protected static final java.lang.Long _DEFAULT_TIME_TO_LIVE

_TIME_TO_LIVE_UNITS_DEFAULT

protected static final java.lang.String _TIME_TO_LIVE_UNITS_DEFAULT

See Also:

Constant Field Values

Constructor Detail

Event

public Event()

Method Detail

generate

@Deprecated
public final void generate()

Deprecated.

Use assertEvent() instead.

assertEvent

protected void assertEvent()
                    throws ObjectNotUniqueError,
                           ResourceUnavailableException

Assert an event.

This method starts a new run-to-completion (RTC) cycle if one is not already active. If there is already an active RTC, this event is added to the current RTC agenda.

If this method started a new RTC cycle, it is complete when this method returns. If there is already an active RTC cycle, this event is just added to the current agenda and it will be executed at the end of the current conflict resolution cycle.

A new transaction is started if one is not already active.

RETE working memory is cleared at the end of the RTC cycle.

Throws:

ObjectNotUniqueError - Duplicate external identifier

ResourceUnavailableException - Rules engine not running

setPayload

@Deprecated
public final void setPayload(java.lang.String payload)
                                  throws java.lang.IllegalArgumentException

Deprecated.

Use setPayLoad(PayLoad) instead.

Parameters:

payload - Payload

Throws:

java.lang.IllegalArgumentException - Null payload specified

setPayLoad

public final void setPayLoad(PayLoad payload)
                      throws java.lang.IllegalArgumentException

Set the event payload.

The payload cannot be changed after an event has been asserted.

Parameters:

payload - A non-null payload to store in this event.

Throws:

java.lang.IllegalArgumentException - Null payload specified

toString

public java.lang.String toString()

Overrides:

toString in class Entity

delete

public abstract void delete()

Delete this event

getPayload

@Deprecated
public java.lang.String getPayload()

Deprecated.

Use getPayLoad() instead.

Returns:

Payload value

getPayLoad

public abstract PayLoad getPayLoad()

Get the event payload

Returns:

The payload stored in this event.

setDestination

public abstract void setDestination(java.lang.String destination)
                             throws java.lang.IllegalArgumentException

Set the event destination

The destination cannot be changed after an event has been asserted.

Destination cannot be null.

Parameters:

destination - Destination value

Throws:

java.lang.IllegalArgumentException - Illegal destination specified

getDestination

public abstract java.lang.String getDestination()

Get the event destination

Returns:

The destination stored in this event.

getRetryOnException

public abstract java.lang.Boolean getRetryOnException()

Get the retry-on-exception value for this event.

Returns:

Retry on exception value

getTimeToLive

public abstract java.lang.Long getTimeToLive()

Get the Time-To-Live value for this event.

Returns:

TTL value

getTimeToLiveUnits

public abstract java.lang.String getTimeToLiveUnits()

Get the Time-To-Live units for this event.

Returns:

TTL units

setRetryOnException

protected abstract void setRetryOnException(java.lang.Boolean retryOnException)

Set retry on exception

Parameters:

retryOnException - Retry on exception value

updatePayLoad

protected abstract void updatePayLoad(PayLoad payload)

Update the internal payload

Parameters:

payload - Payload value

setTimeToLive

protected abstract void setTimeToLive(java.lang.Long timeToLive)

Set the time to live for this event

Parameters:

timeToLive - Time to live value.

setTimeToLiveUnits

protected abstract void setTimeToLiveUnits(java.lang.String timeToLiveUnits)

Set time to live units

Parameters:

timeToLiveUnits - Time to live units

getDispatched

protected abstract java.lang.Boolean getDispatched()

Get the current dispatch state

Returns:

True if dispatched, false otherwise

setDispatched

protected abstract void setDispatched()

Set dispatched to true

updateProperties

protected abstract void updateProperties()

Update event handle properties from shared memory

enforceDispatchState

protected final void enforceDispatchState()
                                   throws java.lang.IllegalStateException

Enforce that setters cannot change fields once event has been asserted

Throws:

java.lang.IllegalStateException - Event already asserted