com.massa.mrules.executable

Interface IExecutable

All Superinterfaces:

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

All Known Subinterfaces:

IAction, IExecutable.ValueReturning, IMruleExecutionSet, IMRuleExecutionSet

All Known Implementing Classes:

AbstractActionPrint, AbstractBasicAction, AbstractExecutable, AbstractMRuleExecutionSet, AbstractSrcTgtAction, AbstractVariableCreator, AbstractVariableCreatorSource, Call, MAccessorWrapper, MActionAdd, MActionAddAll, MActionClear, MActionDefine, MActionExec, MActionFlowControl, MActionPrint, MActionPrintF, MActionResetCache, MActionSet, MActionSort, MActionUndefine, MExecutionBlock, MForEach, MForEachNumber, MIndex, MRule, MRuleExecutionSet, MRuleExecutionSetWrapper, Return

public interface IExecutable
extends IAddon, javax.rules.admin.Rule

Describes the execute method implemented by each class that performs an action (like setting a value or running conditions for example), as opposition with classes which evaluate some conditions. All implementations should be done in a thread safe way for execution. Please note that for compilation, if possible, all implementations should compile internal object in the same order that they are invoked at execution.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IExecutable.ValueReturning Annotating an executable with the ValueReturning interface just points out that this particular executable may return a value, i.e. the IExecutionResult.getReturnedValue() of the execute(IExecutionContext) method's result may be exploited.

Method Summary

Modifier and Type	Method and Description
IExecutable	clone() Clones the IExecutable.
void	compile(ICompilationContext ctxt) Compiles the IExecutable to precompute data, ensure that future executions will work, etc ...
IExecutionResult	execute(IExecutionContext ctxt) Performs the action.
Map<Object,Object>	getProperties() Get all properties.
boolean	hasProperties() Has at least one property.
boolean	hasProperty(Object key) Contains the property identified by the provided key.
void	removeProperty(Object key) Removing property.

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

getImplementationId, 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 com.massa.mrules.util.out.Outable

toString

Methods inherited from interface javax.rules.admin.Rule

getDescription, getName, getProperty, setProperty

Method Detail

compile

void compile(ICompilationContext ctxt)
      throws MRuleValidationException

Compiles the IExecutable to precompute data, ensure that future executions will work, etc ...

Throws:

MRuleValidationException - if validation problem detected.

execute

IExecutionResult execute(IExecutionContext ctxt)
                  throws MExecutionException

Performs the action.

Parameters:

ctxt -

Returns:

ExecutionResultState of the execution. Implementations should precise the semantic of the result, which can not be null.

Throws:

MConditionEvaluationException

MActionExecutionException

MExecutionException

clone

IExecutable clone()

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

Specified by:

clone in interface IAddon

Specified by:

clone in interface IMRulesObject

removeProperty

void removeProperty(Object key)

Removing property.

hasProperty

boolean hasProperty(Object key)

Contains the property identified by the provided key.

hasProperties

boolean hasProperties()

Has at least one property.

getProperties

Map<Object,Object> getProperties()

Get all properties.