com.ibm.workplace.wcm.api
Interface DocumentId

public interface DocumentId

Represents the ID of a Document in the repository.

The String representation of this DocumentId object can be obtained by calling the toString() method. The format of the value returned by the toString() method is not documented, and should not be created manually as it may not be relied upon.

Method Summary

com.ibm.workplace.wcm.api.DocumentLibrary	getContainingLibrary() Retrieves the DocumentLibary for the object with this ID.
java.lang.String	getName() Returns the name of the Document with this DocumentId.
com.ibm.workplace.wcm.api.DocumentType	getType() Returns the type of the Document with this DocumentId.
boolean	isDraft() Returns true if the Document represented by this DocumentId is a draft document.
boolean	isExpired() Returns true if the Document represented by this DocumentId is a expired document.
boolean	isOfType(com.ibm.workplace.wcm.api.DocumentType type) Returns true if and only if the type of the Document represented by this DocumentId is the same as the DocumentType argument.
boolean	isPublished() Returns true if the Document represented by this DocumentId is a published document.
java.lang.String	toString() Returns a String representation of this DocumentId.

Method Detail

getName

public java.lang.String getName()

Returns the name of the Document with this DocumentId.

Returns:

the name

getType

public com.ibm.workplace.wcm.api.DocumentType getType()

Returns the type of the Document with this DocumentId.

Returns:

the type

isOfType

public boolean isOfType(com.ibm.workplace.wcm.api.DocumentType type)

Returns true if and only if the type of the Document represented by this DocumentId is the same as the DocumentType argument.

Parameters:

type - the type to compare

Returns:

true if and only if the type of the Document represented by this DocumentId is the same as the DocumentType argument; false otherwise.

toString

public java.lang.String toString()

Returns a String representation of this DocumentId.

Note: Format should not be relied upon.

Overrides:

toString in class java.lang.Object

Returns:

A String representation of this DocumentId

getContainingLibrary

public com.ibm.workplace.wcm.api.DocumentLibrary getContainingLibrary()

Retrieves the DocumentLibary for the object with this ID.

Returns:

The DocumentLibrary of this object.

isDraft

public boolean isDraft()

Returns true if the Document represented by this DocumentId is a draft document.

Returns:

true if the Document represented by this DocumentId is a draft document; false otherwise.

isPublished

public boolean isPublished()

Returns true if the Document represented by this DocumentId is a published document.

Returns:

true if the Document represented by this DocumentId is a published document; false otherwise.

isExpired

public boolean isExpired()

Returns true if the Document represented by this DocumentId is a expired document.

Returns:

true if the Document represented by this DocumentId is a expired document; false otherwise.