com.ibm.task.api

Class BinaryCustomProperty

java.lang.Object

com.ibm.task.api.BinaryCustomProperty

All Implemented Interfaces:

java.io.Serializable

public final class BinaryCustomProperty
extends java.lang.Object
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 Human Task 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 Human Task Manager.

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
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

Methods

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

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

Constructor Detail

BinaryCustomProperty

public BinaryCustomProperty()

Default constructor needed by deserialization. It initializes the binary custom property.

BinaryCustomProperty

public BinaryCustomProperty(java.lang.String name,
                    java.lang.String dataType,
                    java.lang.String queryString,
                    java.io.Serializable value)
                     throws InvalidLengthException,
                            ParameterNullException

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.

ParameterNullException - If a required parameter is null or an empty.

BinaryCustomProperty

public BinaryCustomProperty(java.lang.String name,
                    java.lang.String dataType,
                    java.lang.String queryString,
                    byte[] buffer)
                     throws InvalidLengthException,
                            ParameterNullException

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.

ParameterNullException - If a required parameter is null or an empty.

Method Detail

getName

public java.lang.String getName()

Returns the name of the binary custom property.

Returns:

The name of the binary custom property.

getDataType

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

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

public java.io.Serializable getValue()
                              throws TaskException

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:

TaskException - If an error occurrs during deserialization of the value.

getValueAsByteArray

public byte[] getValueAsByteArray()
                           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

public void setName(java.lang.String name)
             throws InvalidLengthException,
                    ParameterNullException

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.

ParameterNullException - If the name is null or an empty string.

setDataType

public void setDataType(java.lang.String dataType)
                 throws InvalidLengthException,
                        ParameterNullException

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.

ParameterNullException - If the data type is null or an empty string.

setQueryString

public void setQueryString(java.lang.String queryString)
                    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

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

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.