Package de.xima.fc.interfaces.workflow.event

Interface IWorkflowEventData

All Superinterfaces:
Serializable
All Known Subinterfaces:
IDoiVerifiedEventData, IFormDataAdapterProvidingEvent, IFormRecordProvidingEvent, IFormSubmissionEvent, IHttpContextProvidingEvent, IInvitationErrorEventData, IInvitationSentEventData, IProjectProvidingEvent, IUnhandledExceptionEventData, IXFormProvidingEvent, IXFormRenderConfigProvidingEvent
All Known Implementing Classes:
AFormRecordEventData, AProjectEventData, AWorkflowEventData
public interface IWorkflowEventData extends Serializable
Base interface for all workflow events for the new workflow engine. When an event is fired, the workflow engine receives an instance of this interface and queries each ITriggerHandler for the applicable WorkflowTriggers. Each handler receives the event data and must find all triggers to which the event applies. It then runs all WorkflowTasks for the matched triggers.
Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • getClient

      Mandant getClient()
      Returns:
      The client scope where the event was initiated.

    • getClock

      default Clock getClock()
      Returns:
      The clock to use for obtaining the current time.
      Since:
      8.0.0

    • getDefaultSystemState

      @Deprecated default EWorkflowStateType getDefaultSystemState()
      Deprecated.
      Add a post processor instead.
      Returns:
      The default state that is set when the form record has not state and no state was set by the executed workflow tasks.

    • getLocale

      Locale getLocale()
      Returns:
      The locale to be used for locale-sensitive operations. When not given, the system's or client's default locale is used.

    • getUser

      @Deprecated default Benutzer getUser()
      Deprecated.
      Use getUserModel() instead.
      Returns:
      The user who initiated the event. When not given, an anonymous user is used.

    • getUserModel

      IUser getUserModel()
      Returns:
      The user who initiated the event. When not given, an anonymous user is used.

    • getWorkflowExecutionPostProcessors

      default Iterable<IWorkflowExecutionPostProcessor> getWorkflowExecutionPostProcessors()
      Callback that is called after the workflow was executed, but before the final result is created. Lets you modify the workflow execution context, such as by supplying a default servlet response when none was set.
      Returns:
      The default servlet response provide to use, may be null.