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

Interface WorkflowProcessInstance

All Superinterfaces:
EventListener, NodeInstanceContainer, ProcessInstance
public interface WorkflowProcessInstance extends ProcessInstance, NodeInstanceContainer
A workflow process instance represents one specific instance of a workflow process that is currently executing. It is an extension of a ProcessInstance and contains all runtime state related to the execution of workflow processes.
See Also:

  • Method Details

    • getVariable

      Object getVariable(String name)
      Returns the value of the variable with the given name. Note that only variables in the process-level scope will be searched. Returns null if the value of the variable is null or if the variable cannot be found.
      Specified by:
      getVariable in interface ProcessInstance
      Parameters:
      name - the name of the variable
      Returns:
      the value of the variable, or null if it cannot be found

    • setVariable

      void setVariable(String name, Object value)
      Sets process variable with given value under given name
      Specified by:
      setVariable in interface ProcessInstance
      Parameters:
      name - name of the variable
      value - value of the variable

    • getStartDate

      Date getStartDate()
      Returns start date of this process instance
      Returns:
      actual start date

    • getEndDate

      Date getEndDate()
      Returns end date (either completed or aborted) of this process instance
      Returns:
      actual end date

    • errors

      List<ExecutionsErrorInfo> errors()
      Returns list of errors for this process instance.
      Returns:
      list of errors if the process instance is in error state

    • getCorrelationKey

      String getCorrelationKey()
      Returns optional correlation key assigned to process instance
      Specified by:
      getCorrelationKey in interface ProcessInstance
      Returns:
      correlation key if present otherwise null

    • milestones

      Collection<Milestone> milestones()
      Returns the list of Milestones and their status in the current process instances
      Returns:
      Milestones defined in the process

    • adHocFragments

      Collection<AdHocFragment> adHocFragments()
      Returns:
      AdHocFragments from the process instances

    • getTags

      Collection<Tag> getTags()
      Returns current collection of tags.
      Returns:
      collection of tags

    • evaluateTags

      Collection<Tag> evaluateTags()
      Evaluates all tags to apply any changes of the variables
      Returns:
      collection of tags

    • addTag

      void addTag(String value)
      Adds new tag
      Parameters:
      tag - new tag to be added

    • removedTag

      boolean removedTag(String id)
      Removes the tag associated with given id
      Parameters:
      id - identifier of the tag

    • getMetaData

      Object getMetaData(String name)