javax.rules.admin
Interface RuleExecutionSet

All Superinterfaces:

java.io.Serializable

public interface RuleExecutionSet

extends java.io.Serializable

A named set of executable Rule instances. A RuleExecutionSet can be executed by a rules engine via the RuleSession interface.

See Also:

Rule, RuleSession

Method Summary

java.lang.String	getDefaultObjectFilter() Returns the default ObjectFilter class name associated with this rule execution set.
java.lang.String	getDescription() Get a description of this rule execution set.
java.lang.String	getName() Get the name of this rule execution set.
java.lang.Object	getProperty(java.lang.Object key) Get a user defined or vendor defined property.
java.util.List	getRules() Return a list of all Rules that are part of the RuleExecutionSet
void	setDefaultObjectFilter(java.lang.String objectFilterClassname) Set the default ObjectFilter class.
void	setProperty(java.lang.Object key, java.lang.Object value) Set a user defined or vendor defined property.

Method Detail

getName

public java.lang.String getName()

Get the name of this rule execution set.

Returns:

The name of this rule execution set.

getDescription

public java.lang.String getDescription()

Get a description of this rule execution set.

Returns:

A description of this rule execution set or null of no description is specified.

getProperty

public java.lang.Object getProperty(java.lang.Object key)

Get a user defined or vendor defined property.

Parameters:

key - the key to use to retrieve the property

Returns:

the value bound to the key or null

setProperty

public void setProperty(java.lang.Object key,
                        java.lang.Object value)

Set a user defined or vendor defined property.

Parameters:

key - the key for the property value

value - the value to associate with the key

setDefaultObjectFilter

public void setDefaultObjectFilter(java.lang.String objectFilterClassname)

Set the default ObjectFilter class. This class is instantiated at runtime and used to filter result objects unless another filter is specified using the available APIs in the runtime view of a rule engine.

Setting the class name to null removes the default ObjectFilter.

Parameters:

objectFilterClassname -

getDefaultObjectFilter

public java.lang.String getDefaultObjectFilter()

Returns the default ObjectFilter class name associated with this rule execution set.

Returns:

the default ObjectFilter class name

getRules

public java.util.List getRules()

Return a list of all Rules that are part of the RuleExecutionSet

Returns:

java.util.List