|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.bpe.api.BinaryCustomProperty
public final class BinaryCustomProperty
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.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
Constructor Summary | |
---|---|
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 | |
---|---|
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 |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
public BinaryCustomProperty()
public BinaryCustomProperty(java.lang.String name, java.lang.String dataType, java.lang.String queryString, java.io.Serializable value) throws InvalidLengthException, EngineParameterNullException
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.
InvalidLengthException
- If a parameter value exceeds its size limit.
EngineParameterNullException
- If a required parameter is null or an empty.public BinaryCustomProperty(java.lang.String name, java.lang.String dataType, java.lang.String queryString, byte[] buffer) throws InvalidLengthException, EngineParameterNullException
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.
InvalidLengthException
- If a parameter value exceeds its size limit.
EngineParameterNullException
- If a required parameter is null or an empty.Method Detail |
---|
public java.lang.String getName()
public java.lang.String getDataType()
public java.lang.String getQueryString()
public java.io.Serializable getValue() throws ProcessException
ProcessException
- If an error occurs during deserialization of the value.public byte[] getValueAsByteArray() throws java.io.IOException
java.io.IOException
- If the object could not be serialized.public void setName(java.lang.String name) throws InvalidLengthException, EngineParameterNullException
name
- The name of the binary custom property; must not be greater than 220 bytes.
InvalidLengthException
- If the name has more than 220 bytes.
EngineParameterNullException
- If the name is null or an empty string.public void setDataType(java.lang.String dataType) throws InvalidLengthException, EngineParameterNullException
dataType
- The data type of the binary custom property; must not be greater than 254 bytes.
InvalidLengthException
- If the data type has more than 254 bytes.
EngineParameterNullException
- If the data type is null or an empty string.public void setQueryString(java.lang.String queryString) throws InvalidLengthException
queryString
- The value of the binary custom property that is queryable; must not be greater than 254 bytes.
InvalidLengthException
- If the queryable string has more than 254 bytes.public void setValue(java.io.Serializable value)
value
- The value of the binary custom property.public void setValueFromByteArray(byte[] value)
value
- The value of the binary custom property.
|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |