com.ibm.bpe.api

Class BinaryCustomProperty

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

  1. public final class BinaryCustomProperty
  2. extends java.lang.Object
  3. implements java.io.Serializable
Describes a custom property that has a binary value.

Custom properties allow a user to add additional properties to an object beyond those provided and managed by the Business Flow Manager, for example, a JSP.

The binary custom property may be searched for when an additional queryable string is provided. The data type should specify the type of the binary value. It is, however, not checked by the Business Flow Manager.

Since:
6.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
BinaryCustomProperty()
Default constructor needed by deserialization.
BinaryCustomProperty(java.lang.String name,java.lang.String dataType,java.lang.String queryString,byte[] buffer)
Constructor that builds a binary custom property from the passed values; the binary custom property value is already serialized.
BinaryCustomProperty(java.lang.String name,java.lang.String dataType,java.lang.String queryString,java.io.Serializable value)
Constructor that builds a binary custom property from the passed values.

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
getDataType()
Returns the data type of the binary custom property value.
  1. java.lang.String
getName()
Returns the name of the binary custom property.
  1. java.lang.String
getQueryString()
Returns the queryable string that describes the binary custom property.
  1. java.io.Serializable
getValue()
Returns the value of the binary custom property.
  1. byte[]
getValueAsByteArray()
Returns the value of the binary custom property as byte array.
  1. void
setDataType(java.lang.String dataType)
Sets the data type of the binary custom property value.
  1. void
setName(java.lang.String name)
Sets the name of the binary custom property.
  1. void
setQueryString(java.lang.String queryString)
Sets the queryable string that describes the binary custom property.
  1. void
setValue(java.io.Serializable value)
Sets the value of the binary custom property.
  1. void
setValueFromByteArray(byte[] value)
Sets the value of the binary custom property; the value is already serialized.
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

BinaryCustomProperty

  1. public BinaryCustomProperty()
Default constructor needed by deserialization. It initializes the binary custom property.

BinaryCustomProperty

  1. public BinaryCustomProperty(java.lang.String name,
  2. java.lang.String dataType,
  3. java.lang.String queryString,
  4. java.io.Serializable value)
  5. throws InvalidLengthException
  6. EngineParameterNullException
Constructor that builds a binary custom property from the passed values.
Parameters:
name - The name of the binary custom property; must not be greater than 220 bytes.
dataType - The user-defined data type of the binary custom property; must not be greater than 254 bytes. It is not checked whether the binary custom property is an instance of the specified type.
queryString - An optional user-defined queryable string that allows to search for binary custom properties; must not be greater than 254 bytes.
value - The binary custom property value.
Throws:
InvalidLengthException - If a parameter value exceeds its size limit.
EngineParameterNullException - If a required parameter is null or an empty.

BinaryCustomProperty

  1. public BinaryCustomProperty(java.lang.String name,
  2. java.lang.String dataType,
  3. java.lang.String queryString,
  4. byte[] buffer)
  5. throws InvalidLengthException
  6. EngineParameterNullException
Constructor that builds a binary custom property from the passed values; the binary custom property value is already serialized.
Parameters:
name - The name of the binary custom property; must not be greater than 220 bytes.
dataType - The user-defined data type of the binary custom property; must not be greater than 254 bytes. It is not checked whether the binary custom property is an instance of the specified type.
queryString - An optional user-defined queryable string that allows to search for binary custom properties; must not be greater than 254 bytes.
buffer - The serialized binary custom property value.
Throws:
InvalidLengthException - If a parameter value exceeds its size limit.
EngineParameterNullException - If a required parameter is null or an empty.

Method Detail

getName

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

getDataType

  1. public java.lang.String getDataType( )
Returns the data type of the binary custom property value.
Returns:
The data type of the binary custom property.

getQueryString

  1. public java.lang.String getQueryString( )
Returns the queryable string that describes the binary custom property.
Returns:
The value of the binary custom property that is queryable. If no queryable string is defined, null is returned.

getValue

  1. public java.io.Serializable getValue( )
  2. throws ProcessException
Returns the value of the binary custom property. If needed, the value is deserialized before it is returned.
Returns:
The value of the binary custom property.
Throws:
ProcessException - If an error occurs during deserialization of the value.

getValueAsByteArray

  1. public byte[] getValueAsByteArray( )
  2. throws java.io.IOException
Returns the value of the binary custom property as byte array. If needed, the value is serialized before it is returned.
Returns:
The value of the binary custom property.
Throws:
java.io.IOException - If the object could not be serialized.

setName

  1. public void setName(java.lang.String name)
  2. throws InvalidLengthException
  3. EngineParameterNullException
Sets the name of the binary custom property.
Parameters:
name - The name of the binary custom property; must not be greater than 220 bytes.
Throws:
InvalidLengthException - If the name has more than 220 bytes.
EngineParameterNullException - If the name is null or an empty string.

setDataType

  1. public void setDataType(java.lang.String dataType)
  2. throws InvalidLengthException
  3. EngineParameterNullException
Sets the data type of the binary custom property value.
Parameters:
dataType - The data type of the binary custom property; must not be greater than 254 bytes.
Throws:
InvalidLengthException - If the data type has more than 254 bytes.
EngineParameterNullException - If the data type is null or an empty string.

setQueryString

  1. public void setQueryString(java.lang.String queryString)
  2. throws InvalidLengthException
Sets the queryable string that describes the binary custom property.
Parameters:
queryString - The value of the binary custom property that is queryable; must not be greater than 254 bytes.
Throws:
InvalidLengthException - If the queryable string has more than 254 bytes.

setValue

  1. public void setValue(java.io.Serializable value)
Sets the value of the binary custom property.
Parameters:
value - The value of the binary custom property.

setValueFromByteArray

  1. public void setValueFromByteArray( byte[] value)
Sets the value of the binary custom property; the value is already serialized.
Parameters:
value - The value of the binary custom property.