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

Interface ITaskExecutionResult

All Superinterfaces:
Serializable
All Known Subinterfaces:
ITaskExecutionErrorResult, ITaskExecutionSuccessResult
public interface ITaskExecutionResult extends Serializable
The result of executing a WorkflowTask, returned by the task runner when the task was executed successfully.
Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • asError

      default ITaskExecutionErrorResult asError()
      Returns:
      This result cast to a ITaskExecutionErrorResult if isWasSuccessful() is false, or null otherwise.

    • asSuccess

      default ITaskExecutionSuccessResult asSuccess()
      Returns:
      This result cast to a ITaskExecutionSuccessResult if isWasSuccessful() is true, or null otherwise.

    • getExecutionFinishedOrder

      com.google.common.collect.ImmutableList<Long> getExecutionFinishedOrder()
      Returns:
      The order in which execution of the nodes was started. Each element in this list is the ID of a node. A node may appear multiple times in this list, e.g. when the node was placed inside a loop.

    • getExecutionStartedOrder

      com.google.common.collect.ImmutableList<Long> getExecutionStartedOrder()
      Returns:
      The order in which the nodes finished execution. Each element in this list is the ID of a node. A node may appear multiple times in this list, e.g. when the node was placed inside a loop.

    • getFormDataAdapter

      IFormDataAdapter getFormDataAdapter()
      Returns:
      The new form data that should be set on the form record.

    • getFormRecord

      Vorgang getFormRecord()
      Returns:
      The form record that was passed to the task runner. May be a different instance when the form record was updated.

    • getFrqSessionAttributesMapDiff

      IMapDiff<Serializable,Serializable> getFrqSessionAttributesMapDiff()
      Returns:
      The session attributes map that should be applied to the current FRQ session.
      Since:
      7.4.0

    • getResultMap

      com.google.common.collect.ImmutableMap<Long,com.google.common.collect.ImmutableList<IWorkflowNodeResult>> getResultMap()
      Returns:
      A map between the ID of all executed nodes, and the result that was obtained for them.

    • getServletResponse

      @Nullable IServletResponse getServletResponse()
      Returns:
      The servlet response that should be used to answer the current HTTP request. null in case no response was requested during the task's execution.

    • getSessionAttributesMapDiff

      IMapDiff<String,Serializable> getSessionAttributesMapDiff()
      Returns:
      The session attributes map that should be applied to the current HTTP request.

    • getTasks

      com.google.common.collect.ImmutableList<Long> getTasks()
      Returns:
      The ID of the tasks that were executed. This will be a single-element list if this represents an individual task result, or a list of any number of elements if this represents the combined main workflow result.

    • isWasFormRecordDeleted

      boolean isWasFormRecordDeleted()
      Returns:
      true if the form record was deleted while the tasks were processed.

    • isWasSuccessful

      boolean isWasSuccessful()
      Returns:
      true if this result is a ITaskExecutionSuccessResult, or false if this result is a ITaskExecutionErrorResult.