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

Packages that use PayloadModification

Package	Description
io.axoniq.framework.workflow.dsl.api	Author-facing DSL entry points, step-definition value types, event conditions, and workflow lifecycle exceptions.
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.runtime.api.execution.context	Internal runtime contracts for workflow execution, command dispatch, configuration, and event publication.

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

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

Modifier and Type	Method	Description
PayloadModification	PayloadStepDefinition.modification()	Returns the value of the modification record component.

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

Modifier and Type	Method	Description
PayloadStepDefinition	PayloadStepDefinition.modification(PayloadModification modification)	Returns a copy of this definition with the provided payload modification.

Constructors in io.axoniq.framework.workflow.dsl.api with parameters of type PayloadModification

Modifier	Constructor	Description
	PayloadStepDefinition(PrimitiveMetadata primitiveMetadata, PayloadModification modification)	Creates an instance of a PayloadStepDefinition record class.

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

Methods in io.axoniq.framework.workflow.dsl.base with parameters of type PayloadModification

Modifier and Type	Method	Description
void	BaseWorkflowContext.awaitModifyPayload(String stepName, PayloadModification modification)	Updates the workflow payload with default settings and blocks until the change has been applied.
void	BaseWorkflowContext.awaitModifyPayload(String stepName, PayloadModification modification, UnaryOperator<PayloadStepDefinition> customizer)	Updates the workflow payload and blocks until the change has been applied.
PayloadStepDefinition	BaseWorkflowContext.defaultPayloadStepDefinition(String stepName, PayloadModification modification)	Creates the default payload modification step definition used by the convenience overloads in this class.
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.

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

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

Modifier and Type	Method	Description
PayloadModification	PayloadPrimitive.ModifyPayloadCommand.payloadModification()	Retrieves payload modification function.
PayloadModification	PrimitiveCommands.WorkflowStepResultModifyPayloadCommand.payloadModification()	Returns the value of the payloadModification record component.

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

Modifier and Type	Method	Description
static PrimitiveCommands.WorkflowStepResultModifyPayloadCommand	PrimitiveCommands.modifyPayload(String stepName, PayloadModification payloadModification, EventNameCustomizer eventNameCustomizer)	Factory method to create a PrimitiveCommands.WorkflowStepResultModifyPayloadCommand.

Constructors in io.axoniq.framework.workflow.runtime.api.execution.context with parameters of type PayloadModification

Modifier	Constructor	Description
	WorkflowStepResultModifyPayloadCommand(String stepName, PayloadModification payloadModification, EventNameCustomizer eventNameCustomizer)	Creates an instance of a WorkflowStepResultModifyPayloadCommand record class.