Package com.appiancorp.suiteapi.process.events

Class Event

java.lang.Object
com.appiancorp.suiteapi.process.events.Event
All Implemented Interfaces:
JSONable, JSONCacheable, Serializable
Direct Known Subclasses:
EventProducer, EventTrigger
public class Event extends Object implements JSONCacheable, 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:

  • Field Details

    • MESSAGE_EVENT_TRIGGER

      public static final Long MESSAGE_EVENT_TRIGGER
      Event type code for a receive message event.

    • TIMER_EVENT_TRIGGER

      public static final Long TIMER_EVENT_TRIGGER
      Event type code for a timer event.

    • ERROR_EVENT_TRIGGER

      public static final Long ERROR_EVENT_TRIGGER

    • RULE_EVENT_TRIGGER

      public static final Long RULE_EVENT_TRIGGER
      Event type code for a rule event.

    • MESSAGE_EVENT_PRODUCER

      public static final Long MESSAGE_EVENT_PRODUCER
      Event type code for a send message event.

    • TERMINATE_EVENT_PRODUCER

      public static final Long TERMINATE_EVENT_PRODUCER
      Event type code for a terminate event.

    • SORT_BY_ID

      public static final Integer SORT_BY_ID
      Sort by Event ID.

    • SORT_BY_NAME

      public static final Integer SORT_BY_NAME
      Sort by Event Name.

    • SORT_BY_DESC

      public static final Integer SORT_BY_DESC
      Sort by Event Description.

  • Constructor Details

  • Method Details

    • getPersistentId

      public 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

      public void setPersistentId(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:

    • getId

      public Long getId()
      Gets the ID of event.
      Returns:
      ID of event
      See Also:

    • setId

      public void setId(Long id_)
      Sets the ID of the event.
      Parameters:
      id_ - ID to set to.
      See Also:

    • getName

      public String getName()
      Gets the name of the event.
      Returns:
      name of event
      See Also:

    • setName

      public void setName(String name_)
      Sets the name for the event.
      Parameters:
      name_ - new name of event.
      See Also:

    • getType

      public 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

      public void setType(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:

    • getDesc

      public String getDesc()
      Gets the description of event.
      Returns:
      description of event
      See Also:

    • setDesc

      public void setDesc(String desc_)
      Sets the description of event.
      Parameters:
      desc_ - description of event to set.
      See Also:

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getHiddenAttributes

      public 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(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(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