org.drools.jsr94.rules.admin

Class RuleImpl

java.lang.Object

org.drools.jsr94.rules.admin.RuleImpl

All Implemented Interfaces:

Serializable, javax.rules.admin.Rule

public class RuleImpl
extends Object
implements javax.rules.admin.Rule

The Drools implementation of the Rule interface which provides access to simple metadata for a rule. Related Rule instances are assembled into RuleExecutionSets, which in turn, can be executed by a rules engine via the RuleSession interface.

See Also:

Rule, Serialized Form

Method Summary

Modifier and Type	Method and Description
String	getDescription() Get a description of the rule.
String	getName() Get the name of this rule.
Object	getProperty(Object key) Get a user-defined or Drools-defined property.
void	setProperty(Object key, Object value) Set a user-defined or Drools-defined property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public String getName()

Get the name of this rule.

Specified by:

getName in interface javax.rules.admin.Rule

Returns:

The name of this rule.

getDescription

public String getDescription()

Get a description of the rule.

Specified by:

getDescription in interface javax.rules.admin.Rule

Returns:

A description of the rule or null of no description is specified.

getProperty

public Object getProperty(Object key)

Get a user-defined or Drools-defined property.

Specified by:

getProperty in interface javax.rules.admin.Rule

Parameters:

key - the key to use to retrieve the property

Returns:

the value bound to the key or null

setProperty

public void setProperty(Object key,
                        Object value)

Set a user-defined or Drools-defined property.

Specified by:

setProperty in interface javax.rules.admin.Rule

Parameters:

key - the key for the property value

value - the value to associate with the key