com.appiancorp.suiteapi.process.events

Class Event

java.lang.Object

com.appiancorp.suiteapi.process.events.Event

All Implemented Interfaces:

JSONable, JSONCacheable, java.io.Serializable

Direct Known Subclasses:

EventProducer, EventTrigger

public class Event
extends java.lang.Object
implements JSONCacheable, java.io.Serializable

Base class for all events (both EventTrigger and EventProducer extend this class). This class also contains the type code constants for the different event types. This class should not be instantiated directly. Use EventTrigger.createEventTrigger(Long) or EventProducer.createEventProducer(Long) instead.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Long	ERROR_EVENT_TRIGGER
static java.lang.Long	MESSAGE_EVENT_PRODUCER Event type code for a send message event.
static java.lang.Long	MESSAGE_EVENT_TRIGGER Event type code for a receive message event.
static java.lang.Long	RULE_EVENT_TRIGGER Event type code for a rule event.
static java.lang.Integer	SORT_BY_DESC Sort by Event Description.
static java.lang.Integer	SORT_BY_ID Sort by Event ID.
static java.lang.Integer	SORT_BY_NAME Sort by Event Name.
static java.lang.Long	TERMINATE_EVENT_PRODUCER Event type code for a terminate event.
static java.lang.Long	TIMER_EVENT_TRIGGER Event type code for a timer event.

Fields inherited from interface com.appiancorp.suiteapi.common.JSONable

hiddenAttributes$TRANSIENT

Constructor Summary

Constructors

Constructor and Description
Event() Do not use.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDesc() Gets the description of event.
java.util.HashSet	getHiddenAttributes() Returns the set of attributes (properties) that should not be included in the JSON representation of the object.
java.lang.Long	getId() Gets the ID of event.
java.lang.String	getName() Gets the name of the event.
java.lang.String	getPersistentId() Returns the persistent ID of the event.
java.lang.Long	getType() Gets the type of event.
static boolean	isProducerType(java.lang.Long type_) Determines whether the type code passed in represents a producer.
static boolean	isTriggerType(java.lang.Long type_) Determines whether the type code passed in represents a trigger.
void	setDesc(java.lang.String desc_) Sets the description of event.
void	setId(java.lang.Long id_) Sets the ID of the event.
void	setName(java.lang.String name_) Sets the name for the event.
void	setPersistentId(java.lang.String persistentId_) Sets the persistent ID of the event.
void	setType(java.lang.Long type_) Sets the type of event.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_EVENT_TRIGGER

public static final java.lang.Long MESSAGE_EVENT_TRIGGER

Event type code for a receive message event.

TIMER_EVENT_TRIGGER

public static final java.lang.Long TIMER_EVENT_TRIGGER

Event type code for a timer event.

ERROR_EVENT_TRIGGER

public static final java.lang.Long ERROR_EVENT_TRIGGER

RULE_EVENT_TRIGGER

public static final java.lang.Long RULE_EVENT_TRIGGER

Event type code for a rule event.

MESSAGE_EVENT_PRODUCER

public static final java.lang.Long MESSAGE_EVENT_PRODUCER

Event type code for a send message event.

TERMINATE_EVENT_PRODUCER

public static final java.lang.Long TERMINATE_EVENT_PRODUCER

Event type code for a terminate event.

SORT_BY_ID

public static final java.lang.Integer SORT_BY_ID

Sort by Event ID.

SORT_BY_NAME

public static final java.lang.Integer SORT_BY_NAME

Sort by Event Name.

SORT_BY_DESC

public static final java.lang.Integer SORT_BY_DESC

Sort by Event Description.

Constructor Detail

Event

public Event()

Do not use. This class should not be instantiated directly. Use EventTrigger.createEventTrigger(Long) or EventProducer.createEventProducer(Long) instead.

Method Detail

getPersistentId

public java.lang.String getPersistentId()

Returns the persistent ID of the event. This differs from the ID because it is the same for all instances of the event, whereas a new ID is assigned to every new event instance. When an event is reached in flow, that event is activated (triggers) or fired (producers) and a new instance of that event is created.

Returns:

Persistent ID of event

See Also:

setPersistentId(String)

setPersistentId

public void setPersistentId(java.lang.String persistentId_)

Sets the persistent ID of the event. This differs from the ID because it is the same for all instances of the event, whereas a new ID is assigned to every new event instantiated. When an event is reached in flow, that event is activated (triggers) or fired (producers) and a new instance of that event is created.

Parameters:

persistentId_ - persistent ID to set

See Also:

getPersistentId()

getId

public java.lang.Long getId()

Gets the ID of event.

Returns:

ID of event

See Also:

setId(Long)

setId

public void setId(java.lang.Long id_)

Sets the ID of the event.

Parameters:

id_ - ID to set to.

See Also:

getId()

getName

public java.lang.String getName()

Gets the name of the event.

Returns:

name of event

See Also:

setName(String)

setName

public void setName(java.lang.String name_)

Sets the name for the event.

Parameters:

name_ - new name of event.

See Also:

getName()

getType

public java.lang.Long getType()

Gets the type of event. The type is one of MESSAGE_EVENT_TRIGGER, TIMER_EVENT_TRIGGER, RULE_EVENT_TRIGGER, MESSAGE_EVENT_PRODUCER, or TERMINATE_EVENT_PRODUCER.

Returns:

type of event

See Also:

setType(Long)

setType

public void setType(java.lang.Long type_)

Sets the type of event. The type is one of MESSAGE_EVENT_TRIGGER, TIMER_EVENT_TRIGGER, RULE_EVENT_TRIGGER, MESSAGE_EVENT_PRODUCER, or TERMINATE_EVENT_PRODUCER.

Parameters:

type_ - type of event to set.

See Also:

getType()

getDesc

public java.lang.String getDesc()

Gets the description of event.

Returns:

description of event

See Also:

setDesc(String)

setDesc

public void setDesc(java.lang.String desc_)

Sets the description of event.

Parameters:

desc_ - description of event to set.

See Also:

getDesc()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getHiddenAttributes

public java.util.HashSet getHiddenAttributes()

Description copied from interface: JSONable

Returns the set of attributes (properties) that should not be included in the JSON representation of the object.

Specified by:

getHiddenAttributes in interface JSONable

Returns:

the set of hidden attributes

isProducerType

public static boolean isProducerType(java.lang.Long type_)

Determines whether the type code passed in represents a producer.

Parameters:

type_ - the type code

Returns:

whether the type code represents a producer

isTriggerType

public static boolean isTriggerType(java.lang.Long type_)

Determines whether the type code passed in represents a trigger.

Parameters:

type_ - the type code

Returns:

whether the type code represents a trigger