com.ibm.websphere.brb.implementor
Class RuleTrue

java.lang.Object
  |
  +--com.ibm.websphere.brb.implementor.RuleTrue
All Implemented Interfaces:
RuleImplementor

public class RuleTrue
extends java.lang.Object
implements RuleImplementor

Always returns a true ConstraintReturn.


Constructor Summary
RuleTrue()
          RuleTrue constructor.
 
Method Summary
 java.lang.Object fire(TriggerPoint tp, java.lang.Object target, IRuleCopy rule, java.lang.Object[] parms)
          Invoke this method to elicit the behavior of the RuleImplementor.
 java.lang.String getDescription()
          Returns a String describing the RuleImplementor.
 void init(java.lang.Object[] parms, java.lang.String[] dependentRules, java.lang.String userDefinedData, IRuleCopy rule)
          Just after a RuleImplementor is instantiated through its parameterless constructor (which is the only way RuleImplementors come into existence), this method is called and passed RuleImplementor-specific parameters.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RuleTrue

public RuleTrue()
RuleTrue constructor.
Method Detail

fire

public java.lang.Object fire(TriggerPoint tp,
                             java.lang.Object target,
                             IRuleCopy rule,
                             java.lang.Object[] parms)
                      throws BusinessRuleBeansException
Description copied from interface: RuleImplementor
Invoke this method to elicit the behavior of the RuleImplementor. The behavior is completely determined by the programmer writing the rule implementor class.

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 point
rule - the rule that the implementor is running on behalf of
firingParams - 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()
Description copied from interface: RuleImplementor
Returns a String describing the RuleImplementor. This String may used in an administrative system to describe what the RuleImplementor does. Often the user's task is to choose among a set of RuleImplementors and this description could help them make that choice.

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)
Description copied from interface: RuleImplementor
Just after a RuleImplementor is instantiated through its parameterless constructor (which is the only way RuleImplementors come into existence), this method is called and passed RuleImplementor-specific parameters. These parameters are the Rule initialization parameters.

Specified by:
init in interface RuleImplementor
Following copied from interface: com.ibm.websphere.brb.RuleImplementor
Parameters:
initParams - the parameters needed to initialize this RuleImplementor
dependentRules - the names of the dependent rules to this rule; if there are none, null is passed
userDefinedData - userDefinedData property from the Rule
rule - the Rule on whose behalf the rule implementor is running