com.ibm.websphere.brb.implementor
Class RuleLink
java.lang.Object
|
+--com.ibm.websphere.brb.implementor.RuleLink
- All Implemented Interfaces:
- RuleImplementor
- public class RuleLink
- extends java.lang.Object
- implements RuleImplementor
Fires a dependent rule and returns the result of the
dependent rule. This implementor is primarily used to give
a rule a second name. The rule using this implementor is
linked to the rule specified as a dependent rule. Exactly
one dependent rule name must be specified when using this implementor.
At runtime there must be exactly one rule with the specified dependent
rule name. Otherwise an exception will be thrown.
Constructor Summary |
RuleLink()
Parameterless constructor for RuleLink. |
Method Summary |
java.lang.Object |
fire(TriggerPoint tp,
java.lang.Object target,
IRuleCopy rule,
java.lang.Object[] parms)
Fires the dependent rule and returns the result of the
dependent rule. |
java.lang.String |
getDescription()
The programmer's description of what the algorithm does. |
void |
init(java.lang.Object[] parms,
java.lang.String[] dependentRules,
java.lang.String userDefinedData,
IRuleCopy rule)
Initializes with persistent parameters used by this rule. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
dependentRule
protected java.lang.String dependentRule
RuleLink
public RuleLink()
- Parameterless constructor for RuleLink.
fire
public java.lang.Object fire(TriggerPoint tp,
java.lang.Object target,
IRuleCopy rule,
java.lang.Object[] parms)
throws BusinessRuleBeansException
- Fires the dependent rule and returns the result of the
dependent rule. When the dependent rule is fired, there must
be exactly one rule with that name. Otherwise an exception will
be thrown.
- Specified by:
fire
in interface RuleImplementor
- Following copied from interface:
com.ibm.websphere.brb.RuleImplementor
- Parameters:
tp
- the trigger point which is firing this rule implementor.target
- the target object of the trigger pointrule
- the rule that the implementor is running on behalf offiringParams
- the firing parameters, i.e. those parameters that are passed
to the BRBeans framework at the trigger point- Returns:
- The result of firing the rule implementor. Implementors that carry out
classifications must return a single String. Implementors which check
constraints should generally return a ConstraintReturn, especially if
the results are to be combined and returned by the BRBeans framework.
- Throws:
com.ibm.brb.BusinessRuleBeansException
- Thrown when an error condition is associated
with the fired Rule implementation.
getDescription
public java.lang.String getDescription()
- The programmer's description of what the algorithm does.
- Specified by:
getDescription
in interface RuleImplementor
- Following copied from interface:
com.ibm.websphere.brb.RuleImplementor
- Returns:
- A description of this rule implementor.
init
public void init(java.lang.Object[] parms,
java.lang.String[] dependentRules,
java.lang.String userDefinedData,
IRuleCopy rule)
throws BusinessRuleBeansException
- Initializes with persistent parameters used by this rule. This rule has
one dependent rule whose name is provided and retained.
- Specified by:
init
in interface RuleImplementor
- Following copied from interface:
com.ibm.websphere.brb.RuleImplementor
- Parameters:
initParams
- the parameters needed to initialize this RuleImplementordependentRules
- the names of the dependent rules to this rule; if there are none,
null is passeduserDefinedData
- userDefinedData property from the Rulerule
- the Rule on whose behalf the rule implementor is running