Module io.automatiko.engine.api
Package io.automatiko.engine.api.runtime.process

Interface EventListener

All Known Subinterfaces:
ProcessInstance, WorkflowProcessInstance
public interface EventListener
An interface that represents an element that is listening for specific types of events.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Set<EventDescription<?>>
    getEventDescriptions()
    Returns unique set of event descriptions that this event listener is interested in.
    String[]
    getEventTypes()
    Returns the event types this event listener is interested in.
    void
    signalEvent(String type, Object event)
    Signals that an event has occurred.

  • Method Details

    • signalEvent

      void signalEvent(String type, Object event)
      Signals that an event has occurred. The type parameter defines which type of event and the event parameter can contain additional information related to the event.
      Parameters:
      type - the type of event
      event - the data associated with this event

    • getEventTypes

      String[] getEventTypes()
      Returns the event types this event listener is interested in. May return null if the event types are unknown.

    • getEventDescriptions

      default Set<EventDescription<?>> getEventDescriptions()
      Returns unique set of event descriptions that this event listener is interested in.
      Returns:
      returns set of event definitions awaiting or empty set