com.ibm.websphere.brb.mgmt
Class TriggerPointParameter

java.lang.Object
  extended bycom.ibm.websphere.brb.mgmt.TriggerPointParameter
All Implemented Interfaces:
IParameter, java.io.Serializable

public class TriggerPointParameter
extends java.lang.Object
implements IParameter, java.io.Serializable

A parameter which is retrieved from one of the trigger point firing parameters.

See Also:
Serialized Form

Constructor Summary
TriggerPointParameter(int sourcePosition)
          Creates an IParameter which returns the parameter from the given position in the TriggerPoint firing parameters when getValue is called.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Determine if this object is equal to the object passed in.
 int getSourcePosition()
          Returns the zero-based position of the given parameter which this IParameter will return.
 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 toShortenedXML()
          Returns a shortened XML representation of this IParameter.
 java.lang.String toXML(boolean format, java.lang.String indent)
          Returns the XML representation of this IParameter.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TriggerPointParameter

public TriggerPointParameter(int sourcePosition)
Creates an IParameter which returns the parameter from the given position in the TriggerPoint firing parameters when getValue is called.

Parameters:
sourcePosition - the position of the input array to copy the parameter from
Method Detail

equals

public boolean equals(java.lang.Object obj)
Determine if this object is equal to the object passed in.


getSourcePosition

public int getSourcePosition()
Returns the zero-based position of the given parameter which this IParameter will return.

Returns:
the source position

getUserDescription

public java.lang.String getUserDescription()
Description copied from interface: IParameter
Returns the user's description of this parameter. This is a description that the user enters that describes what this parameter does.

Specified by:
getUserDescription in interface IParameter
Returns:
the user's description, or null if none exists

getValue

public java.lang.Object getValue(java.lang.Object[] tpFiringParams,
                                 java.lang.Object target)
Description copied from interface: IParameter
Gets the value that this parameter represents. This method may determine the value to return based on the input parameters, or may totally ignore them.

Specified by:
getValue in interface IParameter
Parameters:
tpFiringParams - the firing parameters passed from the trigger point
target - the target object passed from the trigger point
Returns:
the object to pass to the rule implementor

getValueDescription

public java.lang.String getValueDescription()
Description copied from interface: IParameter
Returns the text description of the value of this parameter. This description cannot be modified, and is specific to the type of ParameterMapper.

Specified by:
getValueDescription in interface IParameter
Returns:
the description of the Parameter's value

makeCopy

public IParameter makeCopy()
Makes a copy of this object.

Specified by:
makeCopy in interface IParameter
Returns:
A copy of this object.

setUserDescription

public void setUserDescription(java.lang.String newUserDescription)
Description copied from interface: IParameter
Sets the user-specified description of this parameter.

Specified by:
setUserDescription in interface IParameter
Parameters:
newUserDescription - the new description of this parameter

toXML

public java.lang.String toXML(boolean format,
                              java.lang.String indent)
Description copied from interface: IParameter
Returns the XML representation of this IParameter. Parameter 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.

Specified by:
toXML in interface IParameter
Parameters:
format - boolean indicating whether XML should be formatted
indent - the String to use to indent the XML
Returns:
the XML representation

toShortenedXML

public java.lang.String toShortenedXML()
Description copied from interface: IParameter
Returns a shortened XML representation of this IParameter. The purpose of this shortened form is to take up less space when the data is stored in the database for the Rule EJB. There are no public methods available that can read this format. This method should only be used when the Rule EJB is being stored to the database.

FOR IBM INTERNAL USE ONLY

Specified by:
toShortenedXML in interface IParameter