filenet.vw.api

Class VWGuid

java.lang.Object

filenet.vw.api.VWGuid

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public final class VWGuid
extends java.lang.Object
implements java.io.Externalizable

Use this class only as a substitution value type for queries. Values of this type will be substituted into the filter string specified. F_CaseFolder and F_CaseTask are the fields for which values of this type may be substituted.

Since:

PE 5.0.0.0

See Also:

VWLog.startQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[]), VWQueue.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int), VWRoster.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int), Serialized Form

Constructor Summary

Constructors

Constructor and Description
VWGuid() Creates an empty VWGuid instance.
VWGuid(byte[] inBytes) Creates a VWGuid instance having the specified GUID value.
VWGuid(java.lang.String theGuid) Creates a VWGuid instance having the specified GUID value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Indicates whether the specified object is equal to this GUID instance.
byte[]	getBytes() Gets the GUID value as a byte array.
int	hashCode() Gets the hashed value for the GUID.
boolean	isUndefined() Indicates whether the GUID is undefined.
void	readExternal(java.io.ObjectInput in)
java.lang.String	toByteString() Retrieves a string representation of the raw bytes in the GUID.
java.lang.String	toString() Retrieves a string representation of the GUID.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VWGuid

public VWGuid()
       throws VWException

Creates an empty VWGuid instance.

Throws:

VWException

Since:

PE 5.0.0.0

VWGuid

public VWGuid(java.lang.String theGuid)
       throws VWException

Creates a VWGuid instance having the specified GUID value.

Parameters:

theGuid - A String containing the GUID to assign.

Throws:

VWException

Since:

PE 5.0.0.0

VWGuid

public VWGuid(byte[] inBytes)
       throws VWException

Creates a VWGuid instance having the specified GUID value.

Parameters:

inBytes - A GUID value in byte array format.

Throws:

VWException

Since:

PE 5.0.0.0

Method Detail

equals

public boolean equals(java.lang.Object obj)

Indicates whether the specified object is equal to this GUID instance.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The Object to compare to this instance.

Returns:

A value of true is returned if the specified object is equal to this instance; otherwise, false is returned.

Since:

PE 5.0.0.0

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Gets the hashed value for the GUID.

Overrides:

hashCode in class java.lang.Object

Returns:

An integer representing the hashed value.

Since:

PE 5.0.0.0

getBytes

public byte[] getBytes()
                throws VWException

Gets the GUID value as a byte array.

Returns:

A byte array containing the GUID value.

Throws:

VWException

Since:

PE 5.0.0.0

isUndefined

public boolean isUndefined()

Indicates whether the GUID is undefined.

Returns:

A value of true if the GUID value is equal to a null value. A value of false is returned if the GUID is defined.

Since:

PE 5.0.0.0

toString

public java.lang.String toString()

Retrieves a string representation of the GUID.

Overrides:

toString in class java.lang.Object

Returns:

A String containing a text representation of the GUID.

Since:

PE 5.0.0.0

toByteString

public java.lang.String toByteString()

Retrieves a string representation of the raw bytes in the GUID.

Returns:

A String containing a the raw bytes in the GUID.

Since:

PE 5.0.0.5

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException