Interface Workflow.Effect<T>

Type Parameters:
T - The type of the message that must be returned by this call.
All Known Subinterfaces:
Workflow.Effect.TransitionalEffect<T>, Workflow.ReadOnlyEffect<T>
Enclosing class:
Workflow<S>

public static interface Workflow.Effect<T>
An Effect is a description of what the runtime needs to do after the command is handled. You can think of it as a set of instructions you are passing to the runtime, which will process the instructions on your behalf.

Each component defines its own effects, which are a set of predefined operations that match the capabilities of that component.

A Workflow Effect can either:

  • update the state of the workflow
  • define the next step to be executed (transition)
  • pause the workflow
  • end the workflow
  • fail the step or reject a command by returning an error
  • reply to incoming commands