com.ibm.bpe.api

Class StoredQueryProperty

  • java.lang.Object
    • com.ibm.bpe.api.StoredQueryProperty
  • All Implemented Interfaces:
    java.io.Serializable


    public final class StoredQueryProperty
    extends java.lang.Object
    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

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT 
    • Constructor Summary

      Constructors 
      Constructor and Description
      StoredQueryProperty(java.lang.String name, java.lang.String value)
      Constructor.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getName()
      Returns the name of the stored query property.
      java.lang.String getValue()
      Returns the value of the stored query property.
      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
    • Constructor Detail

      • StoredQueryProperty

        public StoredQueryProperty(java.lang.String name,
                           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

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

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

        public void setValue(java.lang.String value)
                      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:
        InvalidLengthException
IBM Business Process ManagerTM
Release 8