|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines the interface for a parameter in BRBeans, either for use as an initialization parameter or
a firing parameter. Before parameters are passed
to the rule, each parameter which is set in the rule has its getValue
method called, the results of which is the actual parameter which is passed
to the rule implementor.
Method Summary | |
java.lang.String |
getUserDescription()
Returns the user's description of this parameter. |
java.lang.Object |
getValue(java.lang.Object[] tpFiringParams,
java.lang.Object target)
Gets the value that this parameter represents. |
java.lang.String |
getValueDescription()
Returns the text description of the value of this parameter. |
IParameter |
makeCopy()
Makes a copy of this object. |
void |
setUserDescription(java.lang.String newUserDescription)
Sets the user-specified description of this parameter. |
java.lang.String |
toXML(boolean format,
java.lang.String indent)
Returns the XML representation of this IParameter. |
Method Detail |
public java.lang.String getUserDescription()
public java.lang.Object getValue(java.lang.Object[] tpFiringParams, java.lang.Object target) throws BusinessRuleBeansException
tpFiringParams
- the firing parameters passed from the trigger pointtarget
- the target object passed from the trigger pointpublic java.lang.String getValueDescription()
public IParameter makeCopy()
public void setUserDescription(java.lang.String newUserDescription)
newUserDescription
- the new description of this parameterpublic java.lang.String toXML(boolean format, java.lang.String indent)
format
indicates whether the
XML should be formatted with indentation and new lines.
Parameter indent
specifies the number of
characters to indent the XML. This value is ignored
if false
is given for parameter
format
.format
- boolean indicating whether XML should be formattedindent
- the String to use to indent the XML
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |