io.nflow.engine.workflow.definition

Interface WorkflowState

All Known Implementing Classes:

BulkWorkflow.State, CronWorkflow.State

public interface WorkflowState

Provides access to the workflow state information.

Method Summary

Modifier and Type	Method and Description
default String	getDescription() Return the description of the workflow state.
WorkflowStateType	getType() Return the workflow state type.
default boolean	isRetryAllowed(Throwable thrown) Deprecated. This will be removed in the next major release. Use new WorkflowSettings.Builder().setExceptionAnalyzer(...) instead.
String	name() Return the name of the workflow state.

Method Detail

name

String name()

Return the name of the workflow state.

Returns:

The name.

getType

WorkflowStateType getType()

Return the workflow state type.

Returns:

The workflow state type.

getDescription

default String getDescription()

Return the description of the workflow state. Default implementation returns name().

Returns:

The description.

isRetryAllowed

@Deprecated
default boolean isRetryAllowed(Throwable thrown)

Deprecated. This will be removed in the next major release. Use new WorkflowSettings.Builder().setExceptionAnalyzer(...) instead.

Return true if this state can be automatically retried after throwing an exception, or false if the workflow instance should move directly to failure state. Default implementation returns true if the throwable class is not annotated with @NonRetryable.

Parameters:

thrown - The thrown exception.

Returns:

True if the state can be retried.