Package de.xima.fc.interfaces.workflow.execution

Interface IWorkflowExecutionContext

All Superinterfaces:
AutoCloseable, Closeable, IBaseWorkflowExecutionContext
All Known Implementing Classes:
WorkflowExecutionContext
public interface IWorkflowExecutionContext extends IBaseWorkflowExecutionContext
The IBaseWorkflowExecutionContext for the new workflow engine operating on WorkflowNodes.
Author:
XIMA MEDIA GmbH

  • Method Details

    • env

      IWorkflowExecutionEnvironmentData env()
      Specified by:
      env in interface IBaseWorkflowExecutionContext
      Returns:
      Data from the current workflow execution, such as the form for which the workflow is executed, and the current client.

    • event

      IWorkflowEventData event()
      Returns:
      The data of the event that triggered the task being executed, i.e. the event to which the task's trigger reacted.

    • event

      default <T extends IWorkflowEventData> T event(Class<T> eventClass)
      Type Parameters:
      T - Desired type of the event.
      Parameters:
      eventClass - Desired type of the event.
      Returns:
      The data of the event that triggered the task being executed, cast to the given type; or null when the event is not of the given type.

    • executor

      IWorkflowExecutor executor()
      Grants access to the executor that can be used to execute children, or to trigger events.
      Returns:
      The executor handler associated with this execution context.

    • file

      IWorkflowFileHandler file()
      Returns:
      The file handler for interacting with files and the file system. Use this to create temporary files, to read files created by other workflow elements, or to attach files to the form record.

    • form

      IWorkflowFormHandler form()
      Returns:
      The file handler for interacting with the form and its data.

    • http

      IWorkflowHttpHandler http()
      Returns:
      The handler for interacting with the current HTTP request. It can be used, for example, to initiate redirects or read/write session parameters. If no HTTP request is currently active, this returns a dummy instance that takes no action.

    • logging

      IWorkflowLoggingHandler logging()
      Returns:
      The handler for interacting with the logging system. Lets you create and retrieve protocol entries.

    • node

      IWorkflowNodeLocator node()
      Returns:
      A handler for locating nodes by their name, ID, or UUID. Also lets you access the node currently being executed.

    • placeholder

      IWorkflowPlaceholderHandler placeholder()
      Specified by:
      placeholder in interface IBaseWorkflowExecutionContext
      Returns:
      A handler for replacing placeholders in strings, using the current workflow execution context. This is a shortcut for the methods provided by {code de.xima.fc.placeholder.PlaceholderReplacer} that supplies the required parameters automatically.

    • processId

      long processId()
      Returns:
      ID of the WorkflowProcess of the task being executed.

    • task

      WorkflowTask task()
      Returns:
      The task that is being executed.

    • variable

      IWorkflowVariableHandler variable()
      Returns:
      The handler for retrieving results of previous workflow actions, or adding new results.