com.beasys.commerce.axiom.document
Class DocumentPk

java.lang.Object
  |
  +--com.beasys.commerce.foundation.SmartKey
        |
        +--com.beasys.commerce.axiom.content.ContentPk
              |
              +--com.beasys.commerce.axiom.document.DocumentPk

public class DocumentPk

extends ContentPk

implements java.io.Serializable

The primary key class for a Document.

See Also:

Serialized Form

Fields inherited from class com.beasys.commerce.axiom.content.ContentPk

identifier

Constructor Summary

DocumentPk()
Default constructor.

DocumentPk(java.lang.String identifier)
Constructor that takes in all of the primary key attributes as parameters.

Method Summary

int	compareTo(java.lang.Object o) Implements to compare the object against the identifier.
int	hashCode() Override to use the hashcode of the identifier.
java.lang.String	toString() Returns the identifier.

Methods inherited from class com.beasys.commerce.foundation.SmartKey

equals

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentPk

public DocumentPk()

Default constructor.

DocumentPk

public DocumentPk(java.lang.String identifier)

Constructor that takes in all of the primary key attributes as parameters. All attribute values will be set to the input parameter values.

Parameters:

identifier - the Document identifier.

Method Detail

compareTo

public int compareTo(java.lang.Object o)

Implements to compare the object against the identifier.

Overrides:

compareTo in class ContentPk

Tags copied from class: SmartKey

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:

ClastCastException - if the specified object's type prevents it from being compared with this SmartKey.

toString

public java.lang.String toString()

Returns the identifier.

Overrides:

toString in class ContentPk

Tags copied from class: SmartKey

Returns:

A String representation of the SmartKey.

hashCode

public int hashCode()

Override to use the hashcode of the identifier.

Overrides:

hashCode in class ContentPk