Package io.axoniq.framework.workflow.configuration

Interface WorkflowModule.WorkflowDefinitionPhase<C extends WorkflowContext>

Type Parameters:

C - the type of WorkflowContext used by the workflows in this module

Enclosing interface:

WorkflowModule<C extends WorkflowContext>

public static interface WorkflowModule.WorkflowDefinitionPhase<C extends WorkflowContext>

Phase of the module's building process in which one or more workflow definitions are provided.

Workflow definitions can be built in two ways:

• autodetected - inspects the given component for workflow annotations and automatically derives the workflow definition.
• declarative - allows manual construction through a series of builder phases covering naming, trigger conditions, and customizations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	WorkflowModule.WorkflowDefinitionPhase.DetectionPhase<C extends WorkflowContext>	Phase of the workflow definition process in which the detection strategy is chosen.
static interface	WorkflowModule.WorkflowDefinitionPhase.FinalizedPhase<C>	Terminal phase of the workflow definition process, indicating the workflow definition is complete.
static interface	WorkflowModule.WorkflowDefinitionPhase.NamingPhase<C extends WorkflowContext>	Phase of the declarative workflow definition process in which the workflow is named.
static interface	WorkflowModule.WorkflowDefinitionPhase.OnPhase<C extends WorkflowContext>	Phase of the declarative workflow definition process in which the trigger condition is defined.
static interface	WorkflowModule.WorkflowDefinitionPhase.WorkflowCustomizationPhase<C extends WorkflowContext>	Phase of the declarative workflow definition process in which optional customizations can be applied.

Method Summary

Modifier and Type	Method	Description
WorkflowModule.OptionalPhase<C>	definition(Function<WorkflowModule.WorkflowDefinitionPhase.DetectionPhase<C>,WorkflowModule.WorkflowDefinitionPhase.FinalizedPhase<C>> definition)	Defines the workflow definitions for this module.

Method Details

definition

WorkflowModule.OptionalPhase<C> definition(Function<WorkflowModule.WorkflowDefinitionPhase.DetectionPhase<C>,WorkflowModule.WorkflowDefinitionPhase.FinalizedPhase<C>> definition)

Defines the workflow definitions for this module.

The provided function receives a WorkflowModule.WorkflowDefinitionPhase.DetectionPhase and should return a WorkflowModule.WorkflowDefinitionPhase.FinalizedPhase, allowing users to chain one or more workflow definitions in a fluent manner.

Parameters:

definition - a function that defines one or more workflows via the WorkflowModule.WorkflowDefinitionPhase.DetectionPhase

Returns:

the WorkflowModule.OptionalPhase phase of this builder, for a fluent API