flux
Interface Action

All Superinterfaces:

java.lang.Cloneable, RuntimeDataMap, java.io.Serializable

All Known Subinterfaces:

AuditTrailTrigger, ConsoleAction, DatabaseActionInfo, DatabaseConditionAction, DatabaseConditionTrigger, DatabaseQueryAction, DatabaseStoredProcedureAction, DatabaseUpdateAction, Decision, DelayTrigger, DynamicEjbEntityAction, DynamicEjbSessionAction, DynamicJavaAction, DynamicRmiAction, EjbEntityAction, EjbSessionAction, ErrorAction, FileCopyAction, FileCreateAction, FileDeleteAction, FileExistTrigger, FileModifiedTrigger, FileMoveAction, FileNotExistTrigger, FileRenameAction, FileTrigger, FlowChartAction, FlowChartTrigger, ForEachAction, ForEachCollectionElementAction, ForEachNumberAction, FtpCommandAction, J2eeAction, J2eeKeyAction, JavaAction, JmsAction, Join, MailAction, MailTrigger, ManualTrigger, NullAction, ProcessAction, RegularExpressionAction, RestAction, RmiAction, Split, TimerTrigger, Trigger, WebServiceAction

All Known Implementing Classes:

fluximpl.file.AbstractDoubleFileParameter, fluximpl.file.pgp.AbstractPgpAction, fluximpl.file.AbstractSingleFileParameter, fluximpl.ActionFlowChartImpl, fluximpl.ActionImpl, FileDecryptPgpAction, fluximpl.file.pgp.decrypt.FileDecryptPgpActionImpl, FileEncryptPgpAction, fluximpl.file.pgp.encrypt.FileEncryptPgpActionImpl, FileUnzipAction, fluximpl.file.zip.FileUnzipActionImpl, FileZipAction, fluximpl.file.zip.FileZipActionImpl

public interface Action
extends RuntimeDataMap, java.lang.Cloneable, java.io.Serializable

Actions are the basic building blocks of a flow chart. They are tasks. They perform the concrete steps in a flow chart.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

Flow	addFlow(Action action) When an action finishes executing, this action is executed next.
Flow	addFlow(Action action, java.lang.String condition) When an action finishes executing, this action is executed next if its condition evaluates to true.
Flow	addSignalFlow(Action action, java.lang.String signal) If the specified signal is raised, the given action is executed next.
java.lang.Object	clone() Makes a deep clone of this action, except that all inbound and outbound flows are removed from the returned action.
java.lang.Object	execute(FlowContext flowContext) Called internally by an engine when an action, or trigger, is executed.
java.lang.String	getDescription() Returns a description of this action meant for human consumption.
java.util.Set<Flow>	getFlows() Returns the set of all outgoing flows from this action.
java.util.Set<java.lang.String>	getHiddenVariableNames() Returns the names of all persistent variables for this action that are hidden.
java.lang.String	getJoinExpression() Returns a join expression that specifies the conditions that must be met before a join point will fire.
java.lang.String	getName() Returns the name for this action.
java.lang.String	getPostscript() Returns the script that is executed at the end of this action.
java.lang.String	getPostscriptLanguage() Returns the scripting language in which the postscript is written.
java.lang.String	getPrescript() Returns the script that is executed at the beginning of this action.
java.lang.String	getPrescriptLanguage() Returns the scripting language in which the prescript is written.
java.lang.Class	getResultInfo() Returns the class of the result object returned from this action's execute method.
java.util.Set<java.lang.String>	getSignalsToMonitor() Returns the signals that this action monitors.
AllowableBusinessInterval	getTimeoutBusinessInterval() Deprecated. Use Action.getTimeoutBusinessIntervalNamespace. Deprecated in Flux 8.0. Will be removed in a future release.
java.lang.String	getTimeoutBusinessIntervalNamespace() Returns the repository namespace to the business interval that is used to calculate the timeout expression.
java.lang.String	getTimeoutExpression() Returns a time expression that specifies the elapsed time that may pass before this action times out.
VariableManager	getVariableManager() Returns the variable manager for this action.
boolean	isEndOfRun() Indicates whether this action is the end of a flow chart run.
boolean	isJoinPoint() Indicates whether this action is a join point.
boolean	isSkippable() Indicates whether this action can be skipped if it generated an exception that caused the flow chart to enter the FAILED state.
boolean	isStartAction() Indicates whether this action is a starting point for the encapsulating flow chart.
boolean	isStartOfRun() Indicates whether this action is the start of a flow chart run.
boolean	isTransactionBreak() Indicates whether this action is a transaction break.
boolean	removeFlow(Flow flow) Removes the specified flow from this action.
void	reset() Resets this action's attributes to their original values.
void	setDescription(java.lang.String comment) Sets a description of this action meant for human consumption.
Flow	setElseFlow(Action action) Sets the next action to execute if all other flow conditions are not satisfied at runtime.
void	setEndOfRun(boolean enabled) Sets whether this action is an end point for a flow chart run.
Flow	setErrorFlow(Action action) If this action ends with an error, sets the next action to execute; the transaction will NOT be rolled back as this error flow executes and before the error action executes.
Flow	setErrorFlowWithoutRollback(Action action) If this action ends with an error, sets the next action to execute; the transaction will NOT be rolled back as execution continues along this error flow.
Flow	setErrorFlowWithRollback(Action action) If this action ends with an error, sets the next action to execute; the transaction will be rolled back as this error flow executes and before the error action executes.
void	setJoinExpression(java.lang.String joinExpression) Sets a join expression that specifies the conditions that must be met before a join point will fire.
void	setJoinPoint(boolean enabled) Indicates whether this action is a join point.
void	setName(java.lang.String name) Sets the name of this action, which must be unique within a flow chart.
void	setPostscript(java.lang.String postscript) Sets the script that is executed at the end of this action.
void	setPostscriptLanguage(java.lang.String postscriptLanguage) Sets the scripting language in which the postscript is written.
void	setPrescript(java.lang.String prescript) Sets the script that is executed at the beginning of this action.
void	setPrescriptLanguage(java.lang.String prescriptLanguage) Sets the scripting language in which the prescript is written.
void	setSignalsToMonitor(java.util.Set<java.lang.String> signals) Sets the signals that this action monitors.
void	setSkippable(boolean enabled) Indicates whether this action can be skipped if it generated an exception that caused the flow chart to enter the FAILED state.
void	setStartAction(boolean enabled) Sets whether this action is a starting point for the encapsulating flow chart.
void	setStartOfRun(boolean enabled) Sets whether this action is a starting point for a flow chart run.
void	setTimeoutBusinessInterval(AllowableBusinessInterval businessInterval) Deprecated. Use Action.setTimeoutBusinessIntervalNamespace. Deprecated in Flux 8.0. Will be removed in a future release.
void	setTimeoutBusinessIntervalNamespace(java.lang.String businessIntervalNamespace) Sets the repository namespace to the business interval that is used to calculate the timeout expression.
void	setTimeoutExpression(java.lang.String timeoutExpression) Returns a time expression that specifies the elapsed time that may pass before this action times out.
Flow	setTimeoutFlow(Action action) Sets the next action to execute if this action times out.
void	setTransactionBreak(boolean enabled) Sets whether this action is a transaction break.
void	verify() Indicates if this action was configured correctly.
void	verifyOnClient() Indicates if this action is configured correctly on or in a client, not necessarily on or in a server.

Methods inherited from interface flux.runtimedatamap.RuntimeDataMap

getRuntimeDataMap, setRuntimeDataMap

Method Detail

clone

java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Makes a deep clone of this action, except that all inbound and outbound flows are removed from the returned action.

Returns:

A deep clone of this action.

Throws:

java.lang.CloneNotSupportedException - If this action could not be cloned deeply.

addFlow

Flow addFlow(Action action)

When an action finishes executing, this action is executed next.

Parameters:

action - The next action to execute.

Returns:

The newly created flow.

addFlow

Flow addFlow(Action action,
             java.lang.String condition)

When an action finishes executing, this action is executed next if its condition evaluates to true.

Parameters:

action - The next action to execute if its condition is satisfied.

condition - The condition governing whether this flow is followed.

Returns:

The newly created flow.

addSignalFlow

Flow addSignalFlow(Action action,
                   java.lang.String signal)

If the specified signal is raised, the given action is executed next.

Parameters:

action - The next action to execute if signal is raised.

signal - The signal governing whether this flow is followed.

Returns:

The newly created flow.

execute

java.lang.Object execute(FlowContext flowContext)
                         throws java.lang.Exception

Called internally by an engine when an action, or trigger, is executed. Custom actions implement this method to define their behavior.

Parameters:

flowContext - The context of the flow chart thus far.

Returns:

The action's execution result, made available to subsequent actions via the flow context.

Throws:

java.lang.Exception - If an action indicates that an error has occurred during its execution.

getDescription

java.lang.String getDescription()

Returns a description of this action meant for human consumption.

Returns:

A description of this action meant for human consumption.

getFlows

java.util.Set<Flow> getFlows()

Returns the set of all outgoing flows from this action.

Returns:

Contains flows from this action.

getHiddenVariableNames

java.util.Set<java.lang.String> getHiddenVariableNames()

Returns the names of all persistent variables for this action that are hidden. Hidden variables are used internally by this action.

Returns:

Contains the names of all persistent variables for this action that are hidden. Variable names are case-insensitive.

getJoinExpression

java.lang.String getJoinExpression()

Returns a join expression that specifies the conditions that must be met before a join point will fire. The syntax for the join expression is available in the Flux manuals. When a non-null join expression is set, this action's join point property is enabled automatically.

Returns:

A join expression that specifies the conditions that must be met before a join point will fire.

getName

java.lang.String getName()

Returns the name for this action.

Returns:

The name for this action.

getPostscript

java.lang.String getPostscript()

Returns the script that is executed at the end of this action. Scripts have access to the flow context. If an exception is thrown out of the script during execution, the entire action is deemed to have thrown an exception and flow chart execution continues past the action using the Flux engine's traditional error handling and error flow behavior.

By default, no script is executed and null is returned.

Returns:

The script that is executed at the end of this action.

getPostscriptLanguage

java.lang.String getPostscriptLanguage()

Returns the scripting language in which the postscript is written. The name of the scripting language is case-insensitive. Defaults to "BeanShell", which represents the BeanShell scripting language. Other scripting languages can be registered through the SCRIPTING_LANGUAGES configuration property.

Returns:

The scripting language in which the postscript is written.

See Also:

Configuration.SCRIPTING_LANGUAGES

getPrescript

java.lang.String getPrescript()

Returns the script that is executed at the beginning of this action. Scripts have access to the flow context. If an exception is thrown out of the script during execution, the entire action is deemed to have thrown an exception and flow chart execution continues past the action using the Flux engine's traditional error handling and error flow behavior.

By default, no script is executed and null is returned.

Returns:

The script that is executed at the beginning of this action.

getPrescriptLanguage

java.lang.String getPrescriptLanguage()

Returns the scripting language in which the prescript is written. The name of the scripting language is case-insensitive. Defaults to "BeanShell", which represents the BeanShell scripting language. Other scripting languages can be registered through the SCRIPTING_LANGUAGES configuration property.

Returns:

The scripting language in which the prescript is written.

See Also:

Configuration.SCRIPTING_LANGUAGES

getResultInfo

java.lang.Class getResultInfo()

Returns the class of the result object returned from this action's execute method. The result object must follow Flux's standard persistence rules for objects with public fields. The result class can be used to provide information about what kind of information this action returns. Use the standard persistence rules to query the result class to determine the names of types of information returned by this action.

If null is returned, it is implied that either this action returns nothing or this action's result object does not follow the standard persistence rules for objects with public fields.

Returns:

The class of the result object returned from this action's execute method.

getSignalsToMonitor

java.util.Set<java.lang.String> getSignalsToMonitor()

Returns the signals that this action monitors. If a signal is raised that matches a signal flow, that flow will be followed immediately if the action has not started to execute. If execute has already begun executing, the flow will be followed as soon as the action completes. If a matching signal flow is not found, but the signal is in the set of signals to monitor, then the current flow of execution ends. If there is only one execution flow in the flow chart, the flow chart is finished and is removed.

Returns:

The signals that this action monitors. A signal is a non-null, non-empty string.

See Also:

FlowContext.isSignalRaised(String)

getTimeoutBusinessInterval

@Deprecated
AllowableBusinessInterval getTimeoutBusinessInterval()

Deprecated. Use Action.getTimeoutBusinessIntervalNamespace. Deprecated in Flux 8.0. Will be removed in a future release.

Returns the business interval that is used to calculate the timeout expression.

Returns:

The business interval that is used to calculate the timeout expression.

getTimeoutBusinessIntervalNamespace

java.lang.String getTimeoutBusinessIntervalNamespace()

Returns the repository namespace to the business interval that is used to calculate the timeout expression.

Returns:

The repository namespace to the business interval that is used to calculate the timeout expression.

getTimeoutExpression

java.lang.String getTimeoutExpression()

Returns a time expression that specifies the elapsed time that may pass before this action times out. When this action finishes and the elapsed running time meets or exceeds the timeout expression, the Flux engine consider this action to have timed out. Flow of control then follows the "timeout" signal flow to the next trigger or action in the flow chart, if any.

Note that if an action times out, the Flux engine will not interrupt the running action. The action will still run to completion. However, the method FlowContext.isTimedOut() can be queried to determine if an action has timed out, so that the running action can perform any appropriate steps.

For example, if the timeout expression is "+20m" (20 minutes), then when exactly 20 minutes has elapsed since the action first started executing, the action times out.

If the timeout expression is null, the action never times out. By default, the timeout expression is null.

Returns:

A time expression that specifies the elapsed time that may pass before this action times out. If the time expression is null, the action never times out.

getVariableManager

VariableManager getVariableManager()

Returns the variable manager for this action. Every action can have persistent variables associated with it for use by actions.

Returns:

The variable manager for this action.

isEndOfRun

boolean isEndOfRun()

Indicates whether this action is the end of a flow chart run. Note that if the end of a run is set on a flow chart, then the start of a run must also be set somewhere on that flow chart.

Returns:

Whether this action is the end of a flow chart run.

See Also:

FlowChartRun

isJoinPoint

boolean isJoinPoint()

Indicates whether this action is a join point. If there is no join point, job execution will not pause at this action to merge multiple inbound flows. Otherwise, execution pauses to merge all inbound flows to this action.

If a join point exists, there is an implicit transaction break before this action.

Returns:

Whether this action is a join point.

isSkippable

boolean isSkippable()

Indicates whether this action can be skipped if it generated an exception that caused the flow chart to enter the FAILED state. When skipped, the flow chart will continue executing from the last transaction break and skip the execution of this action.

If an action is skipped, the result that would otherwise be passed into the skipped action is instead passed through to the action (or actions in the case of a split) immediately following the skipped action.

Returns:

Whether this action can be skipped if it generated an exception which caused the flow chart to enter the ERROR state.

isStartAction

boolean isStartAction()

Indicates whether this action is a starting point for the encapsulating flow chart. Start actions mark the beginning of the flow chart. By default, the first action created in a flow chart is a start action.

Returns:

Whether this action is a starting point for the encapsulating flow chart.

isStartOfRun

boolean isStartOfRun()

Indicates whether this action is the start of a flow chart run. Note that if the start of a run is set on a flow chart, then the end of a run must also be set somewhere on that flow chart.

Returns:

Whether this action is the start of a flow chart run.

See Also:

FlowChartRun

isTransactionBreak

boolean isTransactionBreak()

Indicates whether this action is a transaction break. By default, all triggers are transaction breaks. When a job is running and control flows into an action that is a transaction break, the current transaction is committed.

Returns:

Whether this action is a transaction break.

removeFlow

boolean removeFlow(Flow flow)

Removes the specified flow from this action.

Parameters:

flow - The flow to be removed from this action.

Returns:

Whether the flow was contained in this action and was removed.

reset

void reset()

Resets this action's attributes to their original values.

setDescription

void setDescription(java.lang.String comment)

Sets a description of this action meant for human consumption.

Parameters:

comment - A description of this action meant for human consumption.

setElseFlow

Flow setElseFlow(Action action)

Sets the next action to execute if all other flow conditions are not satisfied at runtime. Note that if there is only one outbound flow associated with an action and that flow is an "else" flow, then the "else" flow will always be followed whenever the action terminates normally.

Parameters:

action - The next action to execute if all other flow conditions are not satisfied at runtime.

Returns:

The newly created flow.

setEndOfRun

void setEndOfRun(boolean enabled)

Sets whether this action is an end point for a flow chart run. A flow chart can have at most one action set as the end of a run. Note that if the end of a run is set on a flow chart, then the start of a run must also be set somewhere on that flow chart.

Parameters:

enabled - Whether this action is an end point for a flow chart run.

See Also:

FlowChartRun

setErrorFlow

Flow setErrorFlow(Action action)

If this action ends with an error, sets the next action to execute; the transaction will NOT be rolled back as this error flow executes and before the error action executes. Note that there can be at most one error flow emanating from an action. This method delegates to setErrorFlowWithoutRollback(Action).

Parameters:

action - The error action to execute next.

Returns:

The newly created flow.

See Also:

setErrorFlowWithoutRollback(Action)

setErrorFlowWithoutRollback

Flow setErrorFlowWithoutRollback(Action action)

If this action ends with an error, sets the next action to execute; the transaction will NOT be rolled back as execution continues along this error flow. Note that there can be at most one error flow emanating from an action.

Parameters:

action - The error action to execute next.

Returns:

The newly created flow.

setErrorFlowWithRollback

Flow setErrorFlowWithRollback(Action action)

If this action ends with an error, sets the next action to execute; the transaction will be rolled back as this error flow executes and before the error action executes. Note that there can be at most one error flow emanating from an action.

Parameters:

action - The error action to execute next.

Returns:

The newly created flow.

setJoinExpression

void setJoinExpression(java.lang.String joinExpression)

Sets a join expression that specifies the conditions that must be met before a join point will fire. The syntax for the join expression is available in the Flux manuals. When a non-null join expression is set, this action's join point property is enabled automatically.

Parameters:

joinExpression - A join expression that specifies the conditions that must be met before a join point will fire.

Throws:

java.lang.IllegalArgumentException - If the join expression is an empty string or otherwise containing an illegal form.

setJoinPoint

void setJoinPoint(boolean enabled)

Indicates whether this action is a join point. If there is no join point, job execution will not pause at this action to merge multiple inbound flows. Otherwise, execution pauses to merge all inbound flows to this action.

If a join point exists, there is an implicit transaction break before this action.

Parameters:

enabled - Whether this action is a join point.

setName

void setName(java.lang.String name)

Sets the name of this action, which must be unique within a flow chart.

Parameters:

name - The name of this action.

setPostscript

void setPostscript(java.lang.String postscript)

Sets the script that is executed at the end of this action. Scripts have access to the flow context. If an exception is thrown out of the script during execution, the entire action is deemed to have thrown an exception and flow chart execution continues past the action using the Flux engine's traditional error handling and error flow behavior.

Parameters:

postscript - The script that is executed at the end of this action. A null script indicates that no script will be executed.

setPostscriptLanguage

void setPostscriptLanguage(java.lang.String postscriptLanguage)

Sets the scripting language in which the postscript is written.

Parameters:

postscriptLanguage - The scripting language in which the postscript is written.

setPrescript

void setPrescript(java.lang.String prescript)

Sets the script that is executed at the beginning of this action. Scripts have access to the flow context. If an exception is thrown out of the script during execution, the entire action is deemed to have thrown an exception and flow chart execution continues past the action using the Flux engine's traditional error handling and error flow behavior.

Parameters:

prescript - The script that is executed at the beginning of this action. A null script indicates that no script will be executed.

setPrescriptLanguage

void setPrescriptLanguage(java.lang.String prescriptLanguage)

Sets the scripting language in which the prescript is written.

Parameters:

prescriptLanguage - The scripting language in which the prescript is written.

setSignalsToMonitor

void setSignalsToMonitor(java.util.Set<java.lang.String> signals)

Sets the signals that this action monitors. If a signal is raised that matches a signal flow, that flow will be followed immediately if the action has not started to execute. If execute has already begun executing, the flow will be followed as soon as the action completes. If a matching signal flow is not found, but the signal is in set of signals to monitor, then the current flow of execution ends. If there is only one execution flow in the flow chart, the flow chart is finished and is removed.

Parameters:

signals - The signals that this action monitors. A signal is a non-null, non-empty string.

Throws:

java.lang.IllegalArgumentException - If signals is null, if signals contains a null value, or if signals contains an empty string.

See Also:

FlowContext.isSignalRaised(String)

setSkippable

void setSkippable(boolean enabled)

Indicates whether this action can be skipped if it generated an exception that caused the flow chart to enter the FAILED state. When skipped, the flow chart will continue executing from the last transaction break and skip the execution of this action.

If an action is skipped, the result that would otherwise be passed into the skipped action is instead passed through to the action (or actions in the case of a split) immediately following the skipped action.

Parameters:

enabled - Whether this action can be skipped if it generated an exception which caused the flow chart to enter the FAILED state.

setStartAction

void setStartAction(boolean enabled)

Sets whether this action is a starting point for the encapsulating flow chart. Start actions mark the beginning of the flow chart. By default, the first action created in a flow chart is a start action.

Parameters:

enabled - Whether this action is a starting point for the encapsulating flow chart.

setStartOfRun

void setStartOfRun(boolean enabled)

Sets whether this action is a starting point for a flow chart run. A flow chart can have at most one action set as the start of a run. Note that if the start of a run is set on a flow chart, then the end of a run must also be set somewhere on that flow chart.

Parameters:

enabled - Whether this action is a starting point for a flow chart run.

See Also:

FlowChartRun

setTimeoutBusinessInterval

@Deprecated
void setTimeoutBusinessInterval(AllowableBusinessInterval businessInterval)

Deprecated. Use Action.setTimeoutBusinessIntervalNamespace. Deprecated in Flux 8.0. Will be removed in a future release.

Sets the business interval that is used to calculate the timeout expression.

Parameters:

businessInterval - The business interval that is used to calculate the timeout expression.

setTimeoutBusinessIntervalNamespace

void setTimeoutBusinessIntervalNamespace(java.lang.String businessIntervalNamespace)

Sets the repository namespace to the business interval that is used to calculate the timeout expression.

Parameters:

businessIntervalNamespace - The repository namespace to the business interval that is used to calculate the timeout expression.

setTimeoutExpression

void setTimeoutExpression(java.lang.String timeoutExpression)
                          throws java.lang.IllegalArgumentException

Returns a time expression that specifies the elapsed time that may pass before this action times out. When this action finishes and the elapsed running time meets or exceeds the timeout expression, the Flux engine consider this action to have timed out. Flow of control then follows the "timeout" signal flow to the next trigger or action in the flow chart, if any.

Note that if an action times out, the Flux engine will not interrupt the running action. The action will still run to completion. However, the method FlowContext.isTimedOut() can be queried to determine if an action has timed out, so that the running action can perform any appropriate steps.

For example, if the timeout expression is "+20m" (20 minutes), then when exactly 20 minutes has elapsed since the action first started executing, the action times out.

If the timeout expression is null, the action never times out. By default, the timeout expression is null.

Parameters:

timeoutExpression - A time expression that specifies the elapsed time that may pass before this action times out. If the time expression is null, the action never times out.

Throws:

java.lang.IllegalArgumentException - If timeoutExpression is the empty string, or if it is not a valid time expression.

setTimeoutFlow

Flow setTimeoutFlow(Action action)

Sets the next action to execute if this action times out. This convenience method returns a Flow that is preconfigured to clear the timeout signal for this action. If additional signals need to be cleared on this flow, first call Flow.getSignalsToClear() to retrieve the set of signals that are already configured to be cleared on this flow, add the new signals to the set, and call Flow.setSignalsToClear() with the updated set. These steps will ensure that the timeout signal is still cleared in the case where you want to clear additional signals on a timeout flow.

Parameters:

action - The next action to execute if this action times out.

Returns:

The newly created flow.

setTransactionBreak

void setTransactionBreak(boolean enabled)

Sets whether this action is a transaction break. By default, all triggers are transaction breaks. When a job is running and control flows into an action that is a transaction break, the current transaction is committed.

Parameters:

enabled - Whether this action is a transaction break.

verify

void verify()
            throws EngineException

Indicates if this action was configured correctly. If this action was initialized correctly, this method returns normally. Otherwise, an exception is thrown, indicating the reason why this action was not configured properly.

Throws:

EngineException - If this action was not configured correctly.

verifyOnClient

void verifyOnClient()
                    throws EngineException

Indicates if this action is configured correctly on or in a client, not necessarily on or in a server. Typically, when an action is verified on or in a client, classes are not checked to see if they exist or contain an expected structure. However, when an action is verified using verify(), classes and their expected structure are indeed checked for correctness.

If this action is initialized correctly, this method returns normally. Otherwise, an exception is thrown, indicating the reason why this action is not configured properly.

Throws:

EngineException - If this action is not configured correctly on or in a client.