Uses of Interface
io.axoniq.framework.workflow.dsl.api.WorkflowStepResult

Packages that use WorkflowStepResult

Package	Description
io.axoniq.framework.workflow.dsl.api
io.axoniq.framework.workflow.dsl.base	Base Java DSL for defining workflow steps, providing the core primitives to execute work, wait for events, modify the workflow payload, sleep, fail, and cancel a workflow.
io.axoniq.framework.workflow.dsl.simple	Convenience Java DSL built on top of the base DSL, adding shortcuts for common workflow steps such as executing without extra input payload, waiting for a typed event, and replacing the workflow payload outright.
io.axoniq.framework.workflow.runtime.api.execution.context	Internal runtime contracts for workflow execution, command dispatch, configuration, and event publication.
io.axoniq.framework.workflow.runtime.execution	Internal implementation of the workflow execution engine: the WorkflowEngine, its scheduling, state and storage, checkpointing/replay support, cancellation coordination, and the delegates implementing individual step primitives.

Uses of WorkflowStepResult in io.axoniq.framework.workflow.dsl.api

Subinterfaces of WorkflowStepResult in io.axoniq.framework.workflow.dsl.api

Modifier and Type	Interface	Description
interface	CombinatorWorkflowStepResult	Result type that all combinator methods (AnyMatchCombinator.anyMatch(java.util.function.Predicate<io.axoniq.framework.workflow.dsl.api.WorkflowStepResult>, io.axoniq.framework.workflow.dsl.api.WorkflowStepResult...), NoneMatchCombinator.noneMatch(java.util.function.Predicate<io.axoniq.framework.workflow.dsl.api.WorkflowStepResult>, io.axoniq.framework.workflow.dsl.api.WorkflowStepResult...), AllMatchCombinator.allMatch(java.util.function.Predicate<io.axoniq.framework.workflow.dsl.api.WorkflowStepResult>, io.axoniq.framework.workflow.dsl.api.WorkflowStepResult...)) are required to return.

Methods in io.axoniq.framework.workflow.dsl.api that return WorkflowStepResult

Modifier and Type	Method	Description
WorkflowStepResult	WorkflowContext.execute(ExecuteStepDefinition stepDefinition)	Executes a step asynchronously from a DSL step definition.
WorkflowStepResult	WorkflowContext.modifyPayload(PayloadStepDefinition stepDefinition)	Applies a payload modification asynchronously from a DSL step definition.
WorkflowStepResult	WorkflowContext.publish(PublishStepDefinition stepDefinition)	Publishes a business event as a durable workflow step from a DSL step definition.
WorkflowStepResult	WorkflowContext.waitForEvent(WaitForStepDefinition stepDefinition)	Starts an asynchronous wait step from a DSL step definition.

Methods in io.axoniq.framework.workflow.dsl.api that return types with arguments of type WorkflowStepResult

Modifier and Type	Method	Description
List<WorkflowStepResult>	CombinatorWorkflowStepResult.matched()	Returns all completed sub-results that satisfy the combinator's predicate at the time of this call.
List<WorkflowStepResult>	CombinatorWorkflowStepResult.unmatched()	Returns all other sub-results that are not in CombinatorWorkflowStepResult.matched().

Methods in io.axoniq.framework.workflow.dsl.api with parameters of type WorkflowStepResult

Modifier and Type	Method	Description
CombinatorWorkflowStepResult	WorkflowContext.allMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Returns a result that completes successfully when every supplied result matches the predicate.
CombinatorWorkflowStepResult	WorkflowContext.anyMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Returns a result that completes successfully when any supplied result matches the predicate.
CombinatorWorkflowStepResult	WorkflowContext.noneMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Returns a result that completes successfully when no supplied result matches the predicate.

Method parameters in io.axoniq.framework.workflow.dsl.api with type arguments of type WorkflowStepResult

Modifier and Type	Method	Description
CombinatorWorkflowStepResult	WorkflowContext.allMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Returns a result that completes successfully when every supplied result matches the predicate.
CombinatorWorkflowStepResult	WorkflowContext.anyMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Returns a result that completes successfully when any supplied result matches the predicate.
CombinatorWorkflowStepResult	WorkflowContext.noneMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Returns a result that completes successfully when no supplied result matches the predicate.

Uses of WorkflowStepResult in io.axoniq.framework.workflow.dsl.base

Methods in io.axoniq.framework.workflow.dsl.base that return WorkflowStepResult

Modifier and Type	Method	Description
WorkflowStepResult	BaseWorkflowContext.execute(String stepName, Map<String,@Nullable Object> inputPayload, PayloadProcessor processor)	Starts an execute step with the default step definition settings.
WorkflowStepResult	BaseWorkflowContext.execute(String stepName, Map<String,@Nullable Object> inputPayload, PayloadProcessor processor, UnaryOperator<ExecuteStepDefinition> customizer)	Starts an execute step that invokes the given payload processor.
WorkflowStepResult	BaseWorkflowContext.modifyPayload(String stepName, PayloadModification modification)	Starts a payload update step with default settings.
WorkflowStepResult	BaseWorkflowContext.modifyPayload(String stepName, PayloadModification modification, UnaryOperator<PayloadStepDefinition> customizer)	Starts a step that updates the workflow payload.
WorkflowStepResult	BaseWorkflowContext.publish(String stepName, EventMessage event, UnaryOperator<PublishStepDefinition> customizer)	Publishes a business event as a durable workflow step and returns a handle to await later.
WorkflowStepResult	BaseWorkflowContext.sleep(String stepName, UnaryOperator<WaitForStepDefinition> customizer)	Starts a sleep step.
WorkflowStepResult	BaseWorkflowContext.waitForEvent(String stepName, EventCondition eventCondition)	Starts a wait-for step with default settings.
WorkflowStepResult	BaseWorkflowContext.waitForEvent(String stepName, EventCondition eventCondition, UnaryOperator<WaitForStepDefinition> customizer)	Starts a wait-for step that completes when a matching event is observed.

Uses of WorkflowStepResult in io.axoniq.framework.workflow.dsl.simple

Methods in io.axoniq.framework.workflow.dsl.simple that return WorkflowStepResult

Modifier and Type	Method	Description
WorkflowStepResult	SimpleWorkflowContext.execute(String stepName, PayloadProcessor processor)	Starts an execute step with an empty step-local input payload.
WorkflowStepResult	SimpleWorkflowContext.execute(String stepName, PayloadProcessor processor, UnaryOperator<ExecuteStepDefinition> customizer)	Starts an execute step with an empty step-local input payload and a customized step definition.
WorkflowStepResult	SimpleWorkflowContext.publish(String stepName, Object payload)	Publishes a business event given as payload.
WorkflowStepResult	SimpleWorkflowContext.publish(String stepName, Object payload, Metadata metadata)	Publishes a business event given as payload and metadata.
WorkflowStepResult	SimpleWorkflowContext.publish(String stepName, EventMessage event)	Publishes a business event as a durable workflow step and returns a handle to await later.
WorkflowStepResult	SimpleWorkflowContext.waitForEvent(String stepName, Class<?> eventType, Associations conditions)	Waits for an event of the given type that matches the provided association conditions.
WorkflowStepResult	SimpleWorkflowContext.waitForEvent(String stepName, Class<?> eventType, Associations conditions, UnaryOperator<WaitForStepDefinition> customizer)	Waits for an event of the given type that matches the provided association conditions.

Uses of WorkflowStepResult in io.axoniq.framework.workflow.runtime.api.execution.context

Methods in io.axoniq.framework.workflow.runtime.api.execution.context that return WorkflowStepResult

Modifier and Type	Method	Description
WorkflowStepResult	ExecutePrimitive.execute(ExecutePrimitive.ExecuteCommand command)	Execute primitive.
WorkflowStepResult	PayloadPrimitive.modifyPayload(PayloadPrimitive.ModifyPayloadCommand command)	Applies payload modification.
WorkflowStepResult	PublishPrimitive.publish(PublishPrimitive.PublishCommand command)	Publishes the event carried by the given command as a durable step and waits until the step is recorded in the workflow state.
WorkflowStepResult	VersionPrimitive.version(VersionPrimitive.VersionCommand command)	Records (or reads back) the migration step for the given stepName.
WorkflowStepResult	WaitForPrimitive.waitForEvent(WaitForPrimitive.WaitForCommand command)	Wait for event.

Methods in io.axoniq.framework.workflow.runtime.api.execution.context with parameters of type WorkflowStepResult

Modifier and Type	Method	Description
CombinatorWorkflowStepResult	AllMatchCombinator.allMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Guard combinator — ensures all completed results match the given predicate.
CombinatorWorkflowStepResult	AnyMatchCombinator.anyMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Predicate-based combinator — resolves when the first completed result matches the given predicate.
CombinatorWorkflowStepResult	NoneMatchCombinator.noneMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Guard combinator — ensures no completed result matches the given predicate.

Method parameters in io.axoniq.framework.workflow.runtime.api.execution.context with type arguments of type WorkflowStepResult

Modifier and Type	Method	Description
CombinatorWorkflowStepResult	AllMatchCombinator.allMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Guard combinator — ensures all completed results match the given predicate.
CombinatorWorkflowStepResult	AnyMatchCombinator.anyMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Predicate-based combinator — resolves when the first completed result matches the given predicate.
CombinatorWorkflowStepResult	NoneMatchCombinator.noneMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Guard combinator — ensures no completed result matches the given predicate.

Uses of WorkflowStepResult in io.axoniq.framework.workflow.runtime.execution

Classes in io.axoniq.framework.workflow.runtime.execution that implement WorkflowStepResult

Modifier and Type	Class	Description
class	StateBasedWorkflowStepResult	Workflow Step result based on the Workflow State.

Methods in io.axoniq.framework.workflow.runtime.execution that return WorkflowStepResult

Modifier and Type	Method	Description
static WorkflowStepResult	WorkflowStepResults.canceled(String stepName)	Constructs cancelled result.
static WorkflowStepResult	WorkflowStepResults.completed(String stepName)	Constructs a completed result that carries no payload — for primitives whose recorded value is read from WorkflowState rather than from the result handle (e.g. the migration primitive).
static WorkflowStepResult	WorkflowStepResults.completed(String stepName, @Nullable Object payload, EventConverter converter)	Constructs completed result.
WorkflowStepResult	AbstractWorkflowContext.execute(ExecuteStepDefinition stepDefinition)
WorkflowStepResult	ExecuteDelegate.execute(ExecutePrimitive.ExecuteCommand command)
WorkflowStepResult	RetryableExecuteDelegate.execute(ExecutePrimitive.ExecuteCommand command)
WorkflowStepResult	WorkflowExecutionOperationsDelegation.execute(ExecutePrimitive.ExecuteCommand command)	Executes the step described by the given command.
static WorkflowStepResult	WorkflowStepResults.failed(String stepName, Throwable error)	Constructs failed result.
WorkflowStepResult	AbstractWorkflowContext.modifyPayload(PayloadStepDefinition stepDefinition)
WorkflowStepResult	PayloadDelegate.modifyPayload(PayloadPrimitive.ModifyPayloadCommand command)
WorkflowStepResult	WorkflowExecutionOperationsDelegation.modifyPayload(PayloadPrimitive.ModifyPayloadCommand command)	Changes the workflow payload according to the given command.
WorkflowStepResult	AbstractWorkflowContext.publish(PublishStepDefinition stepDefinition)
WorkflowStepResult	PublishDelegate.publish(PublishPrimitive.PublishCommand command)
WorkflowStepResult	WorkflowExecutionOperationsDelegation.publish(PublishPrimitive.PublishCommand command)	Publishes a business event as a durable workflow step according to the given command.
static WorkflowStepResult	AbstractStepExecutor.stateBased(String stepName, EventNameCustomizer eventNameCustomizer, WorkflowExecution workflowExecution)	Creates a durable result handle for a step while retaining its event-name customizer for later cancellation.
static WorkflowStepResult	WorkflowStepResults.timeout(String stepName, Duration timeout)	Constructs timed out result.
WorkflowStepResult	VersionDelegate.version(VersionPrimitive.VersionCommand command)
WorkflowStepResult	WorkflowExecutionOperationsDelegation.version(VersionPrimitive.VersionCommand command)	Resolves the workflow version according to the given command.
WorkflowStepResult	AbstractWorkflowContext.waitForEvent(WaitForStepDefinition stepDefinition)
WorkflowStepResult	WaitForDelegate.waitForEvent(WaitForPrimitive.WaitForCommand command)
WorkflowStepResult	WorkflowExecutionOperationsDelegation.waitForEvent(WaitForPrimitive.WaitForCommand command)	Waits for an event according to the given command.

Methods in io.axoniq.framework.workflow.runtime.execution with parameters of type WorkflowStepResult

Modifier and Type	Method	Description
CombinatorWorkflowStepResult	AbstractWorkflowContext.allMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)
CombinatorWorkflowStepResult	AllMatchCombinatorDelegate.allMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)
CombinatorWorkflowStepResult	WorkflowExecutionOperationsDelegation.allMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Combines step results when all results satisfy the predicate.
CombinatorWorkflowStepResult	AbstractWorkflowContext.anyMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)
CombinatorWorkflowStepResult	AnyMatchCombinatorDelegate.anyMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)
CombinatorWorkflowStepResult	WorkflowExecutionOperationsDelegation.anyMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Combines step results when any result satisfies the predicate.
CombinatorWorkflowStepResult	AbstractWorkflowContext.noneMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)
CombinatorWorkflowStepResult	NoneMatchCombinatorDelegate.noneMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)
CombinatorWorkflowStepResult	WorkflowExecutionOperationsDelegation.noneMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Combines step results when no result satisfies the predicate.

Method parameters in io.axoniq.framework.workflow.runtime.execution with type arguments of type WorkflowStepResult

Modifier and Type	Method	Description
CombinatorWorkflowStepResult	AbstractWorkflowContext.allMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)
CombinatorWorkflowStepResult	AllMatchCombinatorDelegate.allMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)
CombinatorWorkflowStepResult	WorkflowExecutionOperationsDelegation.allMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Combines step results when all results satisfy the predicate.
CombinatorWorkflowStepResult	AbstractWorkflowContext.anyMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)
CombinatorWorkflowStepResult	AnyMatchCombinatorDelegate.anyMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)
CombinatorWorkflowStepResult	WorkflowExecutionOperationsDelegation.anyMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Combines step results when any result satisfies the predicate.
CombinatorWorkflowStepResult	AbstractWorkflowContext.noneMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)
CombinatorWorkflowStepResult	NoneMatchCombinatorDelegate.noneMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)
CombinatorWorkflowStepResult	WorkflowExecutionOperationsDelegation.noneMatch(Predicate<WorkflowStepResult> predicate, WorkflowStepResult... results)	Combines step results when no result satisfies the predicate.