com.haley.haleyrules.jsr94
Class RuleImpl

java.lang.Object
  |
  +--com.haley.haleyrules.jsr94.RuleImpl

All Implemented Interfaces:

javax.rules.admin.Rule, java.io.Serializable

public class RuleImpl

extends java.lang.Object

implements javax.rules.admin.Rule, java.io.Serializable

This class implements the Rule interface. The Rule interface 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:

Serialized Form

Method Summary

java.lang.String	getDescription() Gets a desctiption of the rule
java.lang.String	getName() Gets the name of the rule
java.lang.Object	getProperty(java.lang.Object key) Gets a user defined or vendor defined property.
void	setProperty(java.lang.Object key, java.lang.Object value) Set a user defined or vendor defined property.

Methods inherited from class java.lang.Object

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

Method Detail

getDescription

public java.lang.String getDescription()

Gets a desctiption 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.

getName

public java.lang.String getName()

Gets the name of the rule

Specified by:

getName in interface javax.rules.admin.Rule

Returns:

the name of this rule.

getProperty

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

Gets a user defined or vendor defined property. For HaleyRules, this method can be used to get the agenda namd and the Haley ruleset name of a rule.

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

See Also:

HaleyProperties.RULESET_NAME, HaleyProperties.AGENDA_NAME

setProperty

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

Set a user defined or vendor defined property. For HaleyRules, a rule is in an agenda, and an agenda is in a Haley ruleset. The names of the agenda and the ruleset for the rule are set through this method.

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

See Also:

HaleyProperties.RULESET_NAME, HaleyProperties.AGENDA_NAME