Package org.flowable.common.engine.api.delegate.event

# Interface FlowableEventListener

All Known Implementing Classes:
  `AbstractFlowableEngineEventListener`, `AbstractFlowableEventListener`, `BaseEntityEventListener`, `DebugInfoEntityEventListener`

public interface FlowableEventListener
Describes a class that listens for `FlowableEvent`s dispatched by the engine.

Author:
  Frederik Heremans, Joram Barrez, Filip Hrisafov

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getOnTransaction()`
  `default Collection<? extends FlowableEventType>`
  `getTypes()`
  The event types that this event listener needs to be registered for
  `boolean`
  `isFailOnException()`
  `boolean`
  `isFireOnTransactionLifecycleEvent()`
  `void`
  `onEvent(FlowableEvent event)`
  Called when an event has been fired

- ## Method Details

  - ### onEvent

    void onEvent(FlowableEvent event)
    Called when an event has been fired
    Parameters:
      `event` - the event

  - ### isFailOnException

    boolean isFailOnException()
    Returns:
      whether or not the current operation should fail when this listeners execution throws an exception.

  - ### isFireOnTransactionLifecycleEvent

    boolean isFireOnTransactionLifecycleEvent()
    Returns:
      Returns whether this event listener fires immediately when the event occurs or on a transaction lifecycle event (before/after commit or rollback).

  - ### getOnTransaction

    String getOnTransaction()
    Returns:
      if non-null, indicates the point in the lifecycle of the current transaction when the event should be fired.

  - ### getTypes

    default Collection<? extends FlowableEventType> getTypes()
    The event types that this event listener needs to be registered for
    Returns:
      the specific event types that this listeners should register itself for