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

Interface WorkflowInstances

All Superinterfaces:

WorkflowInstanceOperator

All Known Subinterfaces:

WorkflowInstances.Single

public interface WorkflowInstances
extends WorkflowInstanceOperator

Represents a lazy collection of workflow instances matching a query. The collection can contain both live workflow executions and historic workflow instances; obtain the individual instances through instances(). Obtain this result from WorkflowManager.findMany(WorkflowStateQuery). Cancellation requests made through this collection operate only on the matching live executions; historic instances are not modified.

Since:

5.4.0

Author:

Simon Zambrovski

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	WorkflowInstances.Single	Represents a query result containing at most one workflow instance.

Method Summary

Modifier and Type	Method	Description
org.reactivestreams.Publisher<WorkflowInstance>	instances()	Returns a publisher that asynchronously delivers the workflow instances in this batch.
CompletableFuture<Integer>	size()	Returns the number of workflow instances in this collection.

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

requestCancellationOfAllSteps, requestStepCancellation, requestWorkflowCancellation

Method Details

instances

org.reactivestreams.Publisher<WorkflowInstance> instances()

Returns a publisher that asynchronously delivers the workflow instances in this batch.

The publisher must honor subscriber demand and must not perform workflow lookup before a subscriber requests instances.

Returns:

publisher delivering the workflow instances in this batch

size

CompletableFuture<Integer> size()

Returns the number of workflow instances in this collection.

Returns:

future completing with the number of workflow instances in this collection