com.ibm.task.api

Class Parameter

  1. java.lang.Object
  2. extended bycom.ibm.task.api.Parameter
All implemented interfaces:
java.io.Serializable

  1. public final class Parameter
  2. extends java.lang.Object
  3. implements java.io.Serializable
Describes a parameter and its value to set the value of a parameter that is used in query table filters and selection criteria. Note that system parameters $USER and $LOCALE are resolved when the query is run. $LOCALE may be set in the filter options and is modified by the query table runtime before the query is executed.
Since:
7.0
See Also:
Serialized Form

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT

Constructor Summary

Constructor and Description
Parameter()
Default constructor to initialize the parameter options.
Parameter(java.lang.String name,java.io.Serializable value)
Constructor that builds a parameter option from the passed values.

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
getName()
Returns the name of the parameter.
  1. java.io.Serializable
getValue()
Returns the value of the parameter.
  1. void
setParameter(java.lang.String name,java.io.Serializable value)
Sets the parameter.
  1. java.lang.String
toString()
Returns a string representation of the Parameter object.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

  1. public static final java.lang.String COPYRIGHT
See Also:

Constructor Detail

Parameter

  1. public Parameter()
Default constructor to initialize the parameter options.

Parameter

  1. public Parameter(java.lang.String name,
  2. java.io.Serializable value)
Constructor that builds a parameter option from the passed values.
Parameters:
name - The name of the parameter.
value - The value of the parameter.

Method Detail

getName

  1. public java.lang.String getName( )
Returns the name of the parameter.
Returns:
The name of the parameter.

getValue

  1. public java.io.Serializable getValue( )
Returns the value of the parameter.
Returns:
The value of the parameter.

setParameter

  1. public void setParameter(java.lang.String name,
  2. java.io.Serializable value)
Sets the parameter.
Parameters:
name - The name of the parameter.
value - The value of the parameter.

toString

  1. public java.lang.String toString( )
Returns a string representation of the Parameter object.
Overrides:
toString in class java.lang.Object
Returns:
String - A string representation of the object.