com.ibm.workplace.wcm.api
Interface Identity<T>

Type Parameters:

T - The WCM API object type for which this is the Identity

All Superinterfaces:

java.lang.Comparable<java.lang.Object>, java.io.Serializable

All Known Subinterfaces:

DocumentId<T>

public interface Identity<T>
extends java.io.Serializable, java.lang.Comparable<java.lang.Object>

Represents the ID of a WCM API object.

Method Summary

int	compareTo(java.lang.Object o) Compares this object with the specified object for order.
java.lang.String	getID() Returns the unique identity number of this object.
java.lang.Class<T>	getTypeClass() Returns the class of this object.

Method Detail

getID

java.lang.String getID()

Returns the unique identity number of this object.

Returns:

the unique id

getTypeClass

java.lang.Class<T> getTypeClass()

Returns the class of this object.

Returns:

the class of this object

compareTo

int compareTo(java.lang.Object o)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Note: typically, Identity objects are comparable to other Identity objects.

Specified by:

compareTo in interface java.lang.Comparable<java.lang.Object>

Parameters:

o - the Object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

java.lang.ClassCastException - if the specified object's type prevents it from being compared to this Object.

See Also:

Comparable#compareTo(Object)}