com.massa.mrules.callable

Class Return

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.callable.Return

All Implemented Interfaces:

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

@PersistantProperties(properties=@PersistantProperty(property="value"))
public class Return
extends AbstractBasicAction

Stops execution of a ICallable using flow control.

Since:

1.9.0

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	RETURN_ID

Constructor Summary

Constructors

Constructor and Description
Return()

Method Summary

Modifier and Type	Method and Description
Return	clone() Clones the Addon.
protected void	compileExecutable(ICompilationContext ctxt) Called by AbstractExecutable.compile(ICompilationContext) to perform compilation operations.
boolean	equals(Object o)
String	getImplementationId() Unique addon implementation ID.
IReadAccessor	getValue()
int	hashCode()
protected IExecutionResult	internalExecute(IExecutionContext ctxt)
void	setValue(IReadAccessor value)
void	toString(OuterWithLevel outer) Method used to send String representation of the current object to the OuterWithLevel.
boolean	wasRegistered(ICompilationContext ctxt, IAddon parent, AddonInfo info) Convenience method, which does nothing.

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

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

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

RETURN_ID

public static final String RETURN_ID

See Also:

Constant Field Values

Constructor Detail

Return

public Return()

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

wasRegistered

public boolean wasRegistered(ICompilationContext ctxt,
                             IAddon parent,
                             AddonInfo info)
                      throws MRuleValidationException

Description copied from class: AbstractAddon

Convenience method, which does nothing. All implementing classes may override to perform internal operations, starting with a "super" call to keep compatibility with future versions.

Specified by:

wasRegistered in interface IAddon

Overrides:

wasRegistered in class AbstractAddon

parent - Parent from which this instance of addon was registered.

info - Addon info for the currently registered addon

Returns:

false

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 Return 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

getValue

public IReadAccessor getValue()

setValue

public void setValue(IReadAccessor value)