com.dtolabs.rundeck.core.execution.workflow

Class FlowController

java.lang.Object

com.dtolabs.rundeck.core.execution.workflow.FlowController

All Implemented Interfaces:

StatusResult, FlowControl, WorkflowStatusResult

public class FlowController
extends java.lang.Object
implements FlowControl, WorkflowStatusResult

record flow control

Field Summary

Fields inherited from interface com.dtolabs.rundeck.core.execution.workflow.FlowControl

STATUS_FAILED, STATUS_SUCCEEDED

Constructor Summary

Constructors

Constructor and Description
FlowController()

Method Summary

Methods

Modifier and Type	Method and Description
void	Continue() execution continues
ControlBehavior	getControlBehavior()
java.lang.String	getStatusString()
void	Halt(boolean success) execution halts with success or failure
void	Halt(java.lang.String statusString) execution halts with custom status
boolean	isControlled()
boolean	isCustomStatusString()
boolean	isSuccess()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlowController

public FlowController()

Method Detail

Halt

public void Halt(java.lang.String statusString)

Description copied from interface: FlowControl

execution halts with custom status

Specified by:

Halt in interface FlowControl

Halt

public void Halt(boolean success)

Description copied from interface: FlowControl

execution halts with success or failure

Specified by:

Halt in interface FlowControl

Continue

public void Continue()

Description copied from interface: FlowControl

execution continues

Specified by:

Continue in interface FlowControl

getStatusString

public java.lang.String getStatusString()

Specified by:

getStatusString in interface WorkflowStatusResult

Returns:

status string

isCustomStatusString

public boolean isCustomStatusString()

getControlBehavior

public ControlBehavior getControlBehavior()

Specified by:

getControlBehavior in interface WorkflowStatusResult

Returns:

flow control behavior to use

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface StatusResult

Returns:

true if the result was successful

isControlled

public boolean isControlled()

Returns:

true if Halt or Continue has been called.