Overview Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
com.ibm.workplace.wcm.api
Interface DocumentId
public interface DocumentIdRepresents 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 DocumentLibrary getContainingLibrary()
Retrieves the DocumentLibary for the object with this ID.java.lang.String getId()
Returns the unique Id of the Document with this DocumentId.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 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(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 getId
java.lang.String getId()
- Returns the unique Id of the Document with this DocumentId.
- Returns:
- the unique id
getName
java.lang.String getName()
- Returns the name of the Document with this DocumentId.
- Returns:
- the name
getType
DocumentType getType()
- Returns the type of the Document with this DocumentId.
- Returns:
- the type
isOfType
boolean isOfType(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
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
DocumentLibrary getContainingLibrary()
- Retrieves the DocumentLibary for the object with this ID.
- Returns:
- The DocumentLibrary of this object.
isDraft
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
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
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.
Overview Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD