com.massa.mrules.callable

Interface ICallable

All Superinterfaces:

Cloneable, IAddon, IMRulesObject, Outable, Serializable

All Known Implementing Classes:

Function

public interface ICallable
extends IAddon

Describes portions of a ruleset that can be declared and then invoked later during the execution, eventually with arguments.

Since:

1.9.0

Method Summary

Modifier and Type	Method and Description
IExecutionResult	call(IExecutionContext ctxt) Executes the call.
ICallable	clone() Clones the Addon.
void	compile(ICompilationContext ctxt) Compiles this callable and all its sub components.
CostInfo	getEstimatedReadCost(ICompilationContext ctxt) Estimates the whole call complexity, to allow callers to optimize calls.

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

Method Detail

compile

void compile(ICompilationContext ctxt)
      throws MRuleValidationException

Compiles this callable and all its sub components.

Parameters:

ctxt -

Throws:

MRuleValidationException

getEstimatedReadCost

CostInfo getEstimatedReadCost(ICompilationContext ctxt)
                       throws MRuleValidationException

Estimates the whole call complexity, to allow callers to optimize calls.
Calls to non-compiled instance may return non-accurate results.

Parameters:

ctxt - Compilation context.

Returns:

cost info

Throws:

MRuleValidationException - if validation problem detected.

call

IExecutionResult call(IExecutionContext ctxt)
               throws MExecutionException

Executes the call. Might return a value via the IExecutionResult.getReturnedValue() method.

Parameters:

ctxt -

Returns:

Execution result.

Throws:

MExecutionException

clone

ICallable 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 IAddon

Specified by:

clone in interface IMRulesObject