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

Packages that use WorkflowState

Package	Description
io.axoniq.framework.workflow.history.api	Public API for reading historic workflow executions, exposing their final state and a repository abstraction.
io.axoniq.framework.workflow.query.utils	Utilities for evaluating workflow-state queries against in-memory workflow state.
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.api.manager	Provides the outside-in API for locating workflow instances and requesting lifecycle changes from application or administrative code.
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.
io.axoniq.framework.workflow.runtime.test.fixture	The given/when/then style test fixture API for workflow runtime tests, including the staged WorkflowTestFixture, the lower-level WorkflowTestDriver, and the shared testing state and services backing both.
io.axoniq.framework.workflow.runtime.util	Internal runtime utilities for future resolution, workflow event and metadata construction, processing context propagation, reflection, and workflow state inspection.

Uses of WorkflowState in io.axoniq.framework.workflow.history.api

Methods in io.axoniq.framework.workflow.history.api that return WorkflowState

Modifier and Type	Method	Description
WorkflowState	WorkflowHistory.state()	Returns the value of the state record component.

Constructors in io.axoniq.framework.workflow.history.api with parameters of type WorkflowState

Modifier	Constructor	Description
	WorkflowHistory(String workflowId, WorkflowState state)	Creates an instance of a WorkflowHistory record class.

Uses of WorkflowState in io.axoniq.framework.workflow.query.utils

Methods in io.axoniq.framework.workflow.query.utils with parameters of type WorkflowState

Modifier and Type	Method	Description
static boolean	WorkflowStateQueryMatcher.matches(WorkflowStateQuery query, WorkflowState state)	Determines whether a workflow state satisfies every criterion in a query.

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

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

Modifier and Type	Method	Description
WorkflowState	WorkflowExecution.state()	Returns the current workflow state.

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

Modifier and Type	Method	Description
void	WorkflowExecution.initializeState(WorkflowState state)	Initializes this newly created execution with a workflow state.

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

Modifier and Type	Method	Description
void	WorkflowExecution.awaitStateChange(Predicate<WorkflowState> condition)	Applies queued tasks until the condition is satisfied.

Uses of WorkflowState in io.axoniq.framework.workflow.runtime.api.manager

Methods in io.axoniq.framework.workflow.runtime.api.manager that return types with arguments of type WorkflowState

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

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

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

Modifier and Type	Class	Description
class	EventSourcedWorkflowState	Holds the current state of a workflow and modified by the EventSourcedWorkflowState.evolve(org.axonframework.messaging.eventhandling.EventMessage, org.axonframework.messaging.core.unitofwork.ProcessingContext) method receiving messages.

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

Modifier and Type	Method	Description
WorkflowState	EventSourcedWorkflowState.evolve(EventMessage eventMessage, ProcessingContext processingContext)	Applies an event while notifying workflow status listeners.
WorkflowState	SimpleWorkflowExecution.state()

Methods in io.axoniq.framework.workflow.runtime.execution that return types with arguments of type WorkflowState

Modifier and Type	Method	Description
CompletableFuture<Optional<WorkflowState>>	EventSourcedWorkflowStore.findWorkflow(String workflowId, ProcessingContext processingContext)
CompletableFuture<Optional<WorkflowState>>	WorkflowStore.findWorkflow(String workflowId, ProcessingContext processingContext)	Sources the state of a workflow that may not exist.
CompletableFuture<WorkflowState>	EventSourcedWorkflowStore.loadWorkflow(String workflowId, ProcessingContext processingContext)
CompletableFuture<WorkflowState>	WorkflowStore.loadWorkflow(String workflowId, ProcessingContext processingContext)	Loads the event-sourced durable state for a workflow id.

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

Modifier and Type	Method	Description
void	SimpleWorkflowExecution.initializeState(WorkflowState state)
static EventSourcedWorkflowState	EventSourcedWorkflowState.requireEventSourcedState(WorkflowState state)	Returns the event sourced workflow state.

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

Modifier and Type	Method	Description
void	SimpleWorkflowExecution.awaitStateChange(Predicate<WorkflowState> predicate)

Uses of WorkflowState in io.axoniq.framework.workflow.runtime.test.fixture

Methods in io.axoniq.framework.workflow.runtime.test.fixture that return WorkflowState

Modifier and Type	Method	Description
WorkflowState	WorkflowEngineTestingState.state()	Returns the historic workflow state.
default WorkflowState	WorkflowEngineTestingState.workflowStateExists()	Returns the workflow state after asserting it exists.
WorkflowState	WorkflowEngineTestingState.workflowStateMatches(AssertionFailureHandler assertionFailureHandler, Predicate<WorkflowState> predicate)	Waits until the workflow state matches the given predicate.
default WorkflowState	WorkflowEngineTestingState.workflowStateMatches(Predicate<WorkflowState> predicate)	Waits until the workflow state matches the given predicate.

Method parameters in io.axoniq.framework.workflow.runtime.test.fixture with type arguments of type WorkflowState

Modifier and Type	Method	Description
WorkflowState	WorkflowEngineTestingState.workflowStateMatches(AssertionFailureHandler assertionFailureHandler, Predicate<WorkflowState> predicate)	Waits until the workflow state matches the given predicate.
default WorkflowState	WorkflowEngineTestingState.workflowStateMatches(Predicate<WorkflowState> predicate)	Waits until the workflow state matches the given predicate.
SELF	Then.workflowStateSatisfies(Consumer<WorkflowState> workflowStateConsumer)	Applies a given consumer to the workflow state of the current history.
void	WorkflowEngineTestingState.workflowStateSatisfies(Consumer<WorkflowState> workflowStateConsumer)	Applies a consumer to the workflow state.

Uses of WorkflowState in io.axoniq.framework.workflow.runtime.util

Methods in io.axoniq.framework.workflow.runtime.util that return types with arguments of type WorkflowState

Modifier and Type	Method	Description
static Predicate<WorkflowState>	WorkflowStateUtils.stepActive(String stepName)	Creates a predicate that matches when a step in the workflow state exists and is not terminal.
static Predicate<WorkflowState>	WorkflowStateUtils.stepStatus(String stepName, StepStatus status)	Creates a predicate that matches when a step in the workflow state exists and has the specified status.
static Predicate<WorkflowState>	WorkflowStateUtils.stepTerminal(String stepName)	Creates a predicate that matches when a step in the workflow state has reached a terminal status.

Methods in io.axoniq.framework.workflow.runtime.util with parameters of type WorkflowState

Modifier and Type	Method	Description
static boolean	WorkflowStateUtils.isStepActive(WorkflowState state, String stepName)	Checks if a step with the given name exists in the workflow state and has not reached a terminal status.
static boolean	WorkflowStateUtils.isStepStatus(WorkflowState state, String stepName, StepStatus status)	Checks if a step with the given name exists in the workflow state and has the specified status.
static boolean	WorkflowStateUtils.isStepTerminal(WorkflowState state, String stepName)	Checks if a step with the given name exists in the workflow state and has reached a terminal status.
static boolean	WorkflowStateUtils.matchesStep(WorkflowState state, String stepName, Predicate<WorkflowStep> predicate)	Safely inspects a step in state if it exists.