Package akka.javasdk.workflow

Interface Workflow.Effect.Builder<S>

Type Parameters:
S - The type of the state for this workflow.
Enclosing interface:
Workflow.Effect<T>
public static interface Workflow.Effect.Builder<S>
Construct the effect that is returned by the command handler or a step transition.

The effect describes next processing actions, such as updating state, transition to another step and sending a reply.

  • Method Details

    • updateState

      Workflow.Effect.PersistenceEffectBuilder<S> updateState(S newState)

    • pause

      Workflow.Effect.TransitionalEffect<Void> pause()
      Pause the workflow execution and wait for an external input, e.g. via command handler.

    • transitionTo

      <I> Workflow.Effect.TransitionalEffect<Void> transitionTo(String stepName, I input)
      Defines the next step to which the workflow should transition to.

      The step definition identified by stepName must have an input parameter of type I. In other words, the next step call (or asyncCall) must have been defined with a Function that accepts an input parameter of type I.

      Parameters:
      stepName - The step name that should be executed next.
      input - The input param for the next step.

    • transitionTo

      Workflow.Effect.TransitionalEffect<Void> transitionTo(String stepName)
      Defines the next step to which the workflow should transition to.

      The step definition identified by stepName must not have an input parameter. In other words, the next step call (or asyncCall) must have been defined with a Supplier function.

      Parameters:
      stepName - The step name that should be executed next.

    • end

      Workflow.Effect.TransitionalEffect<Void> end()
      Finish the workflow execution. After transition to end, no more transitions are allowed.

    • delete

      Workflow.Effect.TransitionalEffect<Void> delete()
      Finish and delete the workflow execution. After transition to delete, no more transitions are allowed. The actual workflow state deletion is done with a configurable delay to allow downstream consumers to observe that fact.

    • reply

      <R> Workflow.ReadOnlyEffect<R> reply(R replyMessage)
      Create a message reply.
      Type Parameters:
      R - The type of the message that must be returned by this call.
      Parameters:
      replyMessage - The payload of the reply.
      Returns:
      A message reply.

    • reply

      <R> Workflow.ReadOnlyEffect<R> reply(R message, Metadata metadata)
      Reply after for example updateState.
      Type Parameters:
      R - The type of the message that must be returned by this call.
      Parameters:
      message - The payload of the reply.
      metadata - The metadata for the message.
      Returns:
      A message reply.

    • error

      <R> Workflow.ReadOnlyEffect<R> error(String message)
      Create an error reply.
      Type Parameters:
      R - The type of the message that must be returned by this call.
      Parameters:
      message - The error message.
      Returns:
      An error reply.

    • error

      <T> Workflow.ReadOnlyEffect<T> error(CommandException commandException)
      Create an error reply. CommandException will be serialized and sent to the client. It's possible to catch it with try-catch statement or CompletionStage API when using async ComponentClient API.
      Type Parameters:
      T - The type of the message that must be returned by this call.
      Parameters:
      commandException - The command exception to be returned.
      Returns:
      An error reply.