Package io.axoniq.framework.workflow.runtime.api.manager

Interface WorkflowInstance

All Superinterfaces:

WorkflowInstanceOperator

public interface WorkflowInstance
extends WorkflowInstanceOperator

Represents one workflow instance selected by a query. An instance can represent a live execution or a historic workflow instance, and always provides access to its detached state. The inherited cancellation operations act only when the selected instance is live.

Since:

5.4.0

Author:

Simon Zambrovski

Method Summary

Modifier and Type	Method	Description
CompletableFuture<WorkflowState>	state()	Reads the detached workflow state selected for this instance.

Methods inherited from interface io.axoniq.framework.workflow.runtime.api.manager.WorkflowInstanceOperator

requestCancellationOfAllSteps, requestStepCancellation, requestWorkflowCancellation

Method Details

state

CompletableFuture<WorkflowState> state()

Reads the detached workflow state selected for this instance.

Returns:

a future completing with a detached workflow state