com.massa.mrules.action

Class MActionFlowControl

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

com.massa.mrules.executable.AbstractExecutable

com.massa.mrules.action.AbstractBasicAction

com.massa.mrules.action.MActionFlowControl

All Implemented Interfaces:

IAction, IAddon, IMRulesObject, IExecutable, Outable, Serializable, Cloneable, javax.rules.admin.Rule

@PersistantProperty(property="command") @PersistantProperty(property="appliesTo") @PersistantProperty(property="message") @PersistantProperty(property="returnValue")
public class MActionFlowControl
extends AbstractBasicAction

Action that allows to control execution flow. Control flow commands should be placed at end of a block, as it stops the current list of executables.
"appliesTo" allows to control the command target, specifying an Addon name. The current accepted commands are :

• DONTSTOP: If targeted block has the "stopAtFirstValidatedCondition" to true, forces an exception to this directive. "appliesTo" property might precise the block targeted by the exception. If not, first parent block is targeted.
• STOP: Stops execution. "appliesTo" property might precise a block to stop. If not, first parent block is stopped.
• RESTART: Restarts execution. "appliesTo" property might precise a block to restart. If not, first parent block is restarted.
• CONTINUE: Specific command of the "FOREACH" addon, tells to continue directly to the next element.
• RAISEERROR: Throws an error, error code "RAISEERROR", containing the optional "message" property. "appliesTo" property is ignored.
• RETURN: Returns from a ICallable. Addon RETURN should be used instead.

STOP and RETURN accept a return value.
Specific addons might accept commands not listed here. A command will be raised to the root ruleset if it's not catched by an Addon and an execution exception will be raised if it can not be interpreted.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.massa.mrules.executable.IExecutable

IExecutable.ValueReturning

Field Summary

Fields

Modifier and Type	Field and Description
static String	FLOWCONTROL_ID

Constructor Summary

Constructors

Constructor and Description
MActionFlowControl()
MActionFlowControl(String command)
MActionFlowControl(String command, String appliesTo)

Method Summary

Modifier and Type	Method and Description
MActionFlowControl	clone() Clones the Addon.
protected void	compileExecutable(ICompilationContext ctxt) Called by AbstractExecutable.compile(ICompilationContext) to perform compilation operations.
boolean	equals(Object o)
String	getAppliesTo()
String	getCommand()
String	getImplementationId() Unique addon implementation ID.
IReadAccessor	getMessage()
IReadAccessor	getReturnValue()
int	hashCode()
protected IExecutionResult	internalExecute(IExecutionContext ctxt)
void	setAppliesTo(String appliesTo)
void	setCommand(String command)
void	setMessage(IReadAccessor message)
void	setReturnValue(IReadAccessor returnValue)
void	toString(OuterWithLevel outer) Method used to send String representation of the current object to the OuterWithLevel.

Methods inherited from class com.massa.mrules.action.AbstractBasicAction

execute

Methods inherited from class com.massa.mrules.executable.AbstractExecutable

combineResults, compile, compileExecutables, execute, execute, getProperties, getProperty, hasProperties, hasProperty, removeProperty, setProperty

Methods inherited from class com.massa.mrules.addon.AbstractAddon

getInternalCacheIdentifier, isCacheUsed, isInternalCacheIdentifierNeeded, optimize, resetCachedData, setInternalCacheIdentifier, toString, wasRegistered

Methods inherited from class com.massa.mrules.base.AbstractMRulesObject

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.massa.mrules.action.IAction

compile

Methods inherited from interface com.massa.mrules.executable.IExecutable

getProperties, hasProperties, hasProperty, removeProperty

Methods inherited from interface com.massa.mrules.addon.IAddon

getInternalCacheIdentifier, isCacheUsed, isInternalCacheIdentifierNeeded, optimize, resetCachedData, setInternalCacheIdentifier, wasRegistered

Methods inherited from interface com.massa.mrules.base.IMRulesObject

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Methods inherited from interface javax.rules.admin.Rule

getDescription, getName, getProperty, setProperty

Field Detail

FLOWCONTROL_ID

public static final String FLOWCONTROL_ID

See Also:

Constant Field Values

Constructor Detail

MActionFlowControl

public MActionFlowControl()

MActionFlowControl

public MActionFlowControl(String command)

MActionFlowControl

public MActionFlowControl(String command,
                          String appliesTo)

Method Detail

compileExecutable

protected void compileExecutable(ICompilationContext ctxt)
                          throws MRuleValidationException

Description copied from class: AbstractExecutable

Called by AbstractExecutable.compile(ICompilationContext) to perform compilation operations.

Specified by:

compileExecutable in class AbstractExecutable

Throws:

MRuleValidationException

internalExecute

protected IExecutionResult internalExecute(IExecutionContext ctxt)
                                    throws MActionExecutionException

Specified by:

internalExecute in class AbstractExecutable

Returns:

always NA, as no real action is taken here.

Throws:

MActionExecutionException

See Also:

IAction.execute(IExecutionContext)

getImplementationId

public String getImplementationId()

Description copied from interface: IAddon

Unique addon implementation ID. In case of conflict, an Class Initialization error will be raised.

toString

public void toString(OuterWithLevel outer)
              throws IOException

Description copied from interface: Outable

Method used to send String representation of the current object to the OuterWithLevel.

Throws:

IOException

clone

public MActionFlowControl clone()

Description copied from interface: IAddon

Clones the Addon.
The general contract is that the clone of a compiled Addon is still compiled.

Specified by:

clone in interface IAction

Specified by:

clone in interface IAddon

Specified by:

clone in interface IMRulesObject

Specified by:

clone in interface IExecutable

Overrides:

clone in class AbstractBasicAction

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getMessage

public IReadAccessor getMessage()

setMessage

public void setMessage(IReadAccessor message)

getAppliesTo

public String getAppliesTo()

setAppliesTo

public void setAppliesTo(String appliesTo)

getCommand

public String getCommand()

setCommand

public void setCommand(String command)

getReturnValue

public IReadAccessor getReturnValue()

setReturnValue

public void setReturnValue(IReadAccessor returnValue)