Package com.yworkflow.instance.context

Interface WorkflowExecutionContext

All Known Subinterfaces:
MutableWorkflowExecutionContext
public interface WorkflowExecutionContext
Represents the execution context of a call made on a workflow instance. WorkflowExecutionContext provides access to all the necessary information and resources for executing a workflow instance, including the workflow definition, instance store, and execution state.
Since:
1.0
See Also:

  • Method Details

    • getWorkflow

      WorkflowDefinition getWorkflow()
      Gets the workflow definition for this context.
      Returns:
      the workflow definition

    • getClock

      WorkflowClock getClock()
      Gets the workflow clock for this context.
      Returns:
      the workflow clock

    • getWorkflowInstanceId

      Optional<WorkflowInstanceId> getWorkflowInstanceId()
      Gets the workflow instance ID for this context.
      Returns:
      an Optional containing the workflow instance ID if present

    • getCallerContext

      WorkflowCallerContext getCallerContext()
      Gets the caller context for this context.
      Returns:
      the caller context

    • getWorkflowInstanceStore

      WorkflowInstanceStore getWorkflowInstanceStore()
      Gets the workflow instance store for this context.
      Returns:
      the workflow instance store

    • getJoinStateInstances

      Optional<JoinStateInstances> getJoinStateInstances()
      Gets the join state instances for this context.
      Returns:
      an Optional containing the join state instances if present

    • getTransitionId

      Optional<TransitionId> getTransitionId()
      Gets the transition ID for this context.
      Returns:
      an Optional containing the transition ID if present

    • getCreatedState

      Optional<StateInstance> getCreatedState()
      Gets the created state instance for this context.
      Returns:
      an Optional containing the created state instance if present

    • getTransients

      MutableAttributes getTransients()
      Gets the transient attributes associated with this context
      Returns:
      the transient attributes

    • getPersistents

      MutableAttributes getPersistents()
      Gets the persistent attributes associated with this context
      Returns:
      the persistent attributes

    • getInputs

      Attributes getInputs()
      Gets the inputs the context was created with
      Returns:
      the input attributes