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.

Field Summary

static java.lang.String

COPYRIGHT Copyright statement

Method Summary

java.lang.String	getName() Returns the name of the Document with this DocumentId.
DocumentType	getType() Returns the type of the Document with this DocumentId.
boolean	isOfType(DocumentType p_type) Returns true if and only if the type of the Document represented by this DocumentId is the same as the DocumentType argument.
java.lang.String	toString() Returns a String representation of this DocumentId.

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

Copyright statement

See Also:

Constant Field Values

Method Detail

getName

public java.lang.String getName()

Returns the name of the Document with this DocumentId.

Returns:

the name

getType

public DocumentType getType()

Returns the type of the Document with this DocumentId.

Returns:

the type

isOfType

public boolean isOfType(DocumentType p_type)

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

Parameters:

p_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.

Returns:

A String representation of this DocumentId