Class Event
java.lang.Object
com.appiancorp.suiteapi.process.events.Event
- All Implemented Interfaces:
JSONable
,JSONCacheable
,Serializable
- Direct Known Subclasses:
EventProducer
,EventTrigger
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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Long
static final Long
Event type code for a send message event.static final Long
Event type code for a receive message event.static final Long
Event type code for a rule event.static final Integer
Sort by Event Description.static final Integer
Sort by Event ID.static final Integer
Sort by Event Name.static final Long
Event type code for a terminate event.static final Long
Event type code for a timer event.Fields inherited from interface com.appiancorp.suiteapi.common.JSONable
hiddenAttributes$TRANSIENT
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetDesc()
Gets the description of event.Returns the set of attributes (properties) that should not be included in the JSON representation of the object.getId()
Gets the ID of event.getName()
Gets the name of the event.Returns the persistent ID of the event.getType()
Gets the type of event.static boolean
isProducerType
(Long type_) Determines whether the type code passed in represents a producer.static boolean
isTriggerType
(Long type_) Determines whether the type code passed in represents a trigger.void
Sets the description of event.void
Sets the ID of the event.void
Sets the name for the event.void
setPersistentId
(String persistentId_) Sets the persistent ID of the event.void
Sets the type of event.toString()
-
Field Details
-
MESSAGE_EVENT_TRIGGER
Event type code for a receive message event. -
TIMER_EVENT_TRIGGER
Event type code for a timer event. -
ERROR_EVENT_TRIGGER
-
RULE_EVENT_TRIGGER
Event type code for a rule event. -
MESSAGE_EVENT_PRODUCER
Event type code for a send message event. -
TERMINATE_EVENT_PRODUCER
Event type code for a terminate event. -
SORT_BY_ID
Sort by Event ID. -
SORT_BY_NAME
Sort by Event Name. -
SORT_BY_DESC
Sort by Event Description.
-
-
Constructor Details
-
Event
public Event()Do not use. This class should not be instantiated directly. UseEventTrigger.createEventTrigger(Long)
orEventProducer.createEventProducer(Long)
instead.
-
-
Method Details
-
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
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:
-
getId
Gets the ID of event.- Returns:
- ID of event
- See Also:
-
setId
Sets the ID of the event.- Parameters:
id_
- ID to set to.- See Also:
-
getName
Gets the name of the event.- Returns:
- name of event
- See Also:
-
setName
Sets the name for the event.- Parameters:
name_
- new name of event.- See Also:
-
getType
Gets the type of event. The type is one ofMESSAGE_EVENT_TRIGGER
,TIMER_EVENT_TRIGGER
,RULE_EVENT_TRIGGER
,MESSAGE_EVENT_PRODUCER
, orTERMINATE_EVENT_PRODUCER
.- Returns:
- type of event
- See Also:
-
setType
Sets the type of event. The type is one ofMESSAGE_EVENT_TRIGGER
,TIMER_EVENT_TRIGGER
,RULE_EVENT_TRIGGER
,MESSAGE_EVENT_PRODUCER
, orTERMINATE_EVENT_PRODUCER
.- Parameters:
type_
- type of event to set.- See Also:
-
getDesc
Gets the description of event.- Returns:
- description of event
- See Also:
-
setDesc
Sets the description of event.- Parameters:
desc_
- description of event to set.- See Also:
-
toString
-
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 interfaceJSONable
- Returns:
- the set of hidden attributes
-
isProducerType
Determines whether the type code passed in represents a producer.- Parameters:
type_
- the type code- Returns:
- whether the type code represents a producer
-
isTriggerType
Determines whether the type code passed in represents a trigger.- Parameters:
type_
- the type code- Returns:
- whether the type code represents a trigger
-