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

Interface WorkflowInstances.Single

All Superinterfaces:

WorkflowInstanceOperator, WorkflowInstances

Enclosing interface:

WorkflowInstances

public static interface WorkflowInstances.Single
extends WorkflowInstances

Represents a query result containing at most one workflow instance. Obtain this result from WorkflowManager.findOne(WorkflowStateQuery).

Nested Class Summary

Nested classes/interfaces inherited from interface io.axoniq.framework.workflow.runtime.api.manager.WorkflowInstances

WorkflowInstances.Single

Method Summary

Modifier and Type	Method	Description
CompletableFuture<@Nullable WorkflowState>	singleState()	Resolves the detached state of the single workflow instance in this collection.

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

requestCancellationOfAllSteps, requestStepCancellation, requestWorkflowCancellation

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

instances, size

Method Details

singleState

CompletableFuture<@Nullable WorkflowState> singleState()

Resolves the detached state of the single workflow instance in this collection.

Returns:

a future completing with the detached state, or null when no instance matches. If more than one instance matches, CompletableFuture.join() throws a CompletionException whose cause is a NonUniqueWorkflowInstanceMatchException.