com.ibm.bpe.api

Class StoredQueryProperty

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

  1. public final class StoredQueryProperty
  2. extends java.lang.Object
  3. implements java.io.Serializable
Describes a property of a stored query.

Stored query properties allow a user to add user-defined properties to a stored query.

Since:
6.0.2
See Also:
Serialized Form

Field Summary

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

Constructor Summary

Constructor and Description
StoredQueryProperty(java.lang.String name,java.lang.String value)
Constructor.

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
getName()
Returns the name of the stored query property.
  1. java.lang.String
getValue()
Returns the value of the stored query property.
  1. void
setValue(java.lang.String value)
Sets the value of the stored query property.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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

Constructor Detail

StoredQueryProperty

  1. public StoredQueryProperty(java.lang.String name,
  2. java.lang.String value)
Constructor.

Takes a name and value pair and stores it for subsequent calls. The name must not be longer than 64 and value not be longer than 254 bytes in UTF-8 format.

Parameters:
name - The name of the stored query property; not longer than 64 bytes.
value - The value of the stored query property; not longer than 254 bytes.

Method Detail

getName

  1. public java.lang.String getName( )
Returns the name of the stored query property.
Returns:
The name of the stored query property.

getValue

  1. public java.lang.String getValue( )
Returns the value of the stored query property.
Returns:
The value of the stored query property.

setValue

  1. public void setValue(java.lang.String value)
  2. throws InvalidLengthException
Sets the value of the stored query property. The value must not be longer than 254 bytes in UTF-8 format.
Parameters:
value - The value of the stored query property; not longer than 254 bytes.
Throws: