|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
T
- The WCM API typepublic interface DocumentType<T extends WCMApiObject>
This interface is used to define the types of WCMApiObject
s that are
available to the API. Each specific instance can be obtained through
the DocumentTypes
interface.
Note that these apply to all WCMApiObject
s, not just Document
s.
DocumentTypes
Method Summary | |
---|---|
boolean |
equals(java.lang.Object object)
Indicates if this object is equals to the one passed in. |
java.lang.Class<T> |
getApiType()
Returns the WCM API type for this document type. |
java.lang.String |
getTitle(java.util.Locale p_locale)
Get the translated title for the document type. |
int |
hashCode()
Answers an integer hash code for the receiver. |
boolean |
isAuthoringTemplateType()
Checks if the DocumentType is an Authoring Template type. |
boolean |
isContentComponentType()
Checks if the DocumentType is a Content Component type. |
boolean |
isLibraryComponentType()
Checks if the current DocumentType is a Library Component type. |
boolean |
isOfEquivalentType(DocumentType<? extends WCMApiObject> type)
Indicates if this DocumentType is 'equivalent' to the DocumentType passed in. |
boolean |
isOfType(DocumentType<? extends WCMApiObject> type)
Indicates if this DocumentType is of the exact same type
of the DocumentType passed in. |
boolean |
isWorkflowAction()
Checks if the current DocumentType is a Workflow Action type |
java.lang.String |
toString()
Returns a String representation of this object. |
Method Detail |
---|
java.lang.Class<T> getApiType()
boolean isOfEquivalentType(DocumentType<? extends WCMApiObject> type)
DocumentType
is 'equivalent' to the DocumentType
passed in.
This DocumentType
is equivalent to the DocumentType
passed in if they represent the same DocumentType
, or if they
have an 'abstract type' relationship. For instance, DocumentTypes.AuthoringTemplate
DocumentTypes.SiteAreaTemplate
are
of type DocumentTypes.AbstractAuthoringTemplate
, and DocumentTypes.LibraryTextComponent
and the other library components are
all of type DocumentTypes.LibraryComponent
.
type
- the DocumentType
with which to compare.
true
if this DocumentType
is of the type of the DocumentType
argument; false
otherwise.boolean isOfType(DocumentType<? extends WCMApiObject> type)
DocumentType
is of the exact same type
of the DocumentType
passed in.
type
- the DocumentType
with which to compare.
true
if this DocumentType
is of the
exact same type of the DocumentType
argument; false
otherwise.boolean isContentComponentType()
DocumentType
is a Content Component type.
DocumentType
is a Content Component type, false otherwiseboolean isAuthoringTemplateType()
DocumentType
is an Authoring Template type.
DocumentType
is an Authoring Template type, false otherwiseboolean isLibraryComponentType()
DocumentType
is a Library Component type.
DocumentType
is a Library Component type, false otherwiseboolean isWorkflowAction()
DocumentType
is a Workflow Action type
DocumentType
is a Workflow Action type, false otherwisejava.lang.String toString()
String
representation of this object.
Currently this returns the class name of the implementing class for the WCM API Interface,
though this should not be relied upon. Use getApiType()
in preference to this method, since
the return type of getApiType()
can be relied upon not to change.
toString
in class java.lang.Object
String
version of this object.java.lang.String getTitle(java.util.Locale p_locale)
p_locale
- locale
boolean equals(java.lang.Object object)
DocumentType
s are equal if they represent the same DocumentType
, except for
that special case that DocumentTypes.Site
is treated as equal to DocumentTypes.SiteArea
.
equals
in class java.lang.Object
object
- the reference object with which to compare.
true
if this object is the same as the object argument; false
otherwise.int hashCode()
true
when passed to
.equals
must answer the same value for this
method.
hashCode
in class java.lang.Object
equals(java.lang.Object)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |