|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
T
- The WCM API typepublic interface DocumentId<T extends Document>
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.
This is an immutable type.
Method Summary | |
---|---|
java.lang.Class<T> |
getApiTypeClass()
Returns the WCM API type of the Document with this
DocumentId . |
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<T> |
getType()
Returns the type of the Document with this
DocumentId , e.g. |
java.lang.Class<T> |
getTypeClass()
Returns the class of the Document with this
DocumentId . |
boolean |
isDeleted()
Returns true if the Document
represented by this DocumentId is a deleted document. |
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 |
isOfEquivalentType(DocumentType<? extends Document> type)
Indicates if the type of the Document represented by this DocumentId is 'equivalent' to
the DocumentType passed in. |
boolean |
isOfType(DocumentType<? extends Document> type)
Indicates if the type of the Document represented by this DocumentId is of the exact same type
of the DocumentType passed in. |
boolean |
isPublished()
Returns true if the Document
represented by this DocumentId is a published document. |
boolean |
isPurged()
Returns true if the Document
represented by this DocumentId is a purged document. |
java.lang.String |
toString()
Returns a String representation of this
DocumentId . |
Methods inherited from interface com.ibm.workplace.wcm.api.Identity |
---|
compareTo, getID |
Method Detail |
---|
java.lang.String getId()
Document
with this
DocumentId
.
java.lang.String getName()
Document
with this
DocumentId
.
DocumentType<T> getType()
Document
with this
DocumentId
, e.g. DocumentType<Content>
java.lang.Class<T> getApiTypeClass()
Document
with this
DocumentId
. This is a convenience method that returns the same
value as getType().getApiType().
java.lang.Class<T> getTypeClass()
Document
with this
DocumentId
.
Note: This returns the class name of the implementing class for the WCM API type,
which may change, and so should therefore not be relied upon. Use getApiTypeClass()
in preference to this method, since
the return type of getApiTypeClass()
can be relied upon not to change.
getTypeClass
in interface Identity<T extends Document>
boolean isOfEquivalentType(DocumentType<? extends Document> type)
Document
represented by this DocumentId
is 'equivalent' to
the DocumentType
passed in.
This returns the same value as getType().isOfEquivalentType().
type
- the DocumentType
with which to compare.
true
if the Document
represented by this DocumentId
is 'equivalent'
to the DocumentType
argument; false
otherwise.DocumentType#isOfEquivalentType(DocumentType)}
boolean isOfType(DocumentType<? extends Document> type)
Document
represented by this DocumentId
is of the exact same type
of the DocumentType
passed in.
This returns the same value as getType().isOfType().
type
- the DocumentType
with which to compare.
true
if the Document
represented by this DocumentId
is of the
exact same type of the DocumentType
argument; false
otherwise.DocumentType#isOfType(DocumentType)}
java.lang.String toString()
String
representation of this
DocumentId
.
Note: Format should not be relied upon, apart from as an opaque String
that can be passed back into Workspace.createDocumentId(String)
in order to serialize/deserialize a DocumentId
.
toString
in class java.lang.Object
String
representation of this
DocumentId
DocumentLibrary getContainingLibrary()
DocumentLibary
for the object with
this ID.
DocumentLibrary
of this object.boolean isDraft()
Document
represented by this DocumentId
is a draft document.
Document
represented by this DocumentId
is a draft document;
false otherwise.boolean isPublished()
Document
represented by this DocumentId
is a published document.
Document
represented by this DocumentId
is a published document;
false otherwise.boolean isExpired()
Document
represented by this DocumentId
is a expired document.
Document
represented by this DocumentId
is a expired document;
false otherwise.boolean isPurged()
Document
represented by this DocumentId
is a purged document.
Document
represented by this DocumentId
is a purged document;
false otherwise.boolean isDeleted()
Document
represented by this DocumentId
is a deleted document.
Document
represented by this DocumentId
is a deleted document;
false otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |