Package com.axelor.workflow.plan

Record Class WorkflowPlan

java.lang.Object

java.lang.Record

com.axelor.workflow.plan.WorkflowPlan

public record WorkflowPlan(String id, String name, WorkflowPlan.StartPlan start, Map<String,WorkflowPlan.Step> steps)
extends Record

The immutable compiled form of a workflow, produced by WorkflowCompiler. The runtime reads only this, never the XML.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	WorkflowPlan.AgentStep	Invokes an AI agent with prompt and binds the answer as agent.
static final record	WorkflowPlan.Boundary	A compiled <boundary>: one way out of its host and where to continue.
static final record	WorkflowPlan.Branch
static interface	WorkflowPlan.Callee	Where a child graph comes from: WorkflowPlan.Callee.Ref names another definition, resolved when the node runs; WorkflowPlan.Callee.Inline carries the body's plan, compiled with the caller and so pinned to its revision.
static final record	WorkflowPlan.CallStep	A <call>: runs the workflow named ref as a child run.
static final record	WorkflowPlan.EmailStep	A template-based email for the workflow record, with its error boundaries.
static final record	WorkflowPlan.EndStep	The walk stops here.
static interface	WorkflowPlan.Invocation	A <call> or <subflow>: a child graph run over a selection.
static interface	WorkflowPlan.JoinPolicy	A join's completion policy: All waits for every selected branch to arrive or end, Quorum(n) for the first n arrivals, cancelling the rest (n=1 is any).
static final record	WorkflowPlan.JoinStep	A join: the some/all split it closes and its completion policy.
static final record	WorkflowPlan.ScriptStep	Runs a script body against the record context; it may create and save records.
static final record	WorkflowPlan.Selection	What a call or subflow runs on: at most one of record, each and filter, none meaning this record.
static final record	WorkflowPlan.SendStep	A compiled <send>: a message (name and key) or a signal (name alone), and where the walk goes next.
static final record	WorkflowPlan.SplitStep	A split.
static final record	WorkflowPlan.StartPlan	The start node's firing configuration.
static interface	WorkflowPlan.Step	A compiled node.
static final record	WorkflowPlan.SubflowStep	A <subflow>: runs its embedded body inside this run.
static final record	WorkflowPlan.TaskStep	A human task.
static final record	WorkflowPlan.WaitStep

Constructor Summary

Constructors

Constructor	Description
WorkflowPlan(String id, String name, WorkflowPlan.StartPlan start, Map<String,WorkflowPlan.Step> steps)	Creates an instance of a WorkflowPlan record class.

Method Summary

Modifier and Type	Method	Description
static List<String>	boundaryTargets(String next, List<WorkflowPlan.Boundary> boundaries)	A node's edges: its continuation, then one per boundary, in order and without duplicates.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	id()	Returns the value of the id record component.
String	name()	Returns the value of the name record component.
WorkflowPlan.StartPlan	start()	Returns the value of the start record component.
String	startNodeId()	The first executable node: the start's next.
WorkflowPlan.Step	step(String id)
Map<String,WorkflowPlan.Step>	steps()	Returns the value of the steps record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

WorkflowPlan

public WorkflowPlan(String id,
 String name,
 WorkflowPlan.StartPlan start,
 Map<String,WorkflowPlan.Step> steps)

Creates an instance of a WorkflowPlan record class.

Parameters:

id - the value for the id record component

name - the value for the name record component

start - the value for the start record component

steps - the value for the steps record component

Method Details

startNodeId

public String startNodeId()

The first executable node: the start's next.

step

public WorkflowPlan.Step step(String id)

boundaryTargets

public static List<String> boundaryTargets(String next,
 List<WorkflowPlan.Boundary> boundaries)

A node's edges: its continuation, then one per boundary, in order and without duplicates.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

start

public WorkflowPlan.StartPlan start()

Returns the value of the start record component.

Returns:

the value of the start record component

steps

public Map<String,WorkflowPlan.Step> steps()

Returns the value of the steps record component.

Returns:

the value of the steps record component