Interface HippoDocumentBean
- All Superinterfaces:
Comparable<HippoBean>
,ContentBean
,HippoBean
,HippoTranslated
,IdentifiableContentBean
,NodeAware
,ObjectConverterAware
,PageModelEntity
This is a marker interface for all beans that represent a document. When developers implement their own bean which
does not extend the standard HippoDocument bean, they should implement this interface. This ensures that linkrewriting
works correctly for extensions like .html or .xml etc etc
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescription<T extends HippoBean>
HippoAvailableTranslationsBean<T>getAvailableTranslations
(Class<T> beanMappingClass) Returns the jcr path of the backing canonical handle jcr node ornull
whenReturns the jcr uuid of the backing canonical handle jcr node ornull
whendefault String
The representational id for aIdentifiableContentBean
is by default equal to theIdentifiableContentBean.getIdentifier()
however implementations can change choose to return another id than theIdentifiableContentBean.getIdentifier()
.Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface org.hippoecm.hst.content.beans.standard.HippoBean
equalCompare, getAvailableTranslations, getBean, getBean, getBeanByUUID, getCanonicalBean, getCanonicalPath, getCanonicalUUID, getChildBeans, getChildBeans, getChildBeansByName, getChildBeansByName, getComparePath, getContentType, getDisplayName, getEqualComparator, getLinkedBean, getLinkedBeans, getMultipleProperty, getMultipleProperty, getName, getNode, getParentBean, getPath, getProperties, getProperty, getSingleProperty, getSingleProperty, getValueProvider, isAncestor, isDescendant, isHippoDocumentBean, isHippoFolderBean, isLeaf, isSelf, isVersionedNode
Methods inherited from interface org.hippoecm.hst.content.beans.standard.HippoTranslated
getLocale, getLocaleString
Methods inherited from interface org.hippoecm.hst.content.beans.standard.IdentifiableContentBean
getIdentifier, setIdentifier
Methods inherited from interface org.hippoecm.hst.content.beans.manager.ObjectConverterAware
getObjectConverter, setObjectConverter
-
Method Details
-
getCanonicalHandleUUID
String getCanonicalHandleUUID()Returns the jcr uuid of the backing canonical handle jcr node ornull
when- there is no canonical node
- the jcr node is detached
- a repository exception happened
- Returns:
- the uuid of the canonical handle or
null
- See Also:
-
getCanonicalHandlePath
String getCanonicalHandlePath()Returns the jcr path of the backing canonical handle jcr node ornull
when- there is no canonical node
- the jcr node is detached
- a repository exception happened
- Returns:
- the jcr path of the canonical handle or
null
- See Also:
-
getAvailableTranslations
<T extends HippoBean> HippoAvailableTranslationsBean<T> getAvailableTranslations(Class<T> beanMappingClass) - Parameters:
beanMappingClass
- only return translations of typebeanMappingClass
- Returns:
- a
HippoAvailableTranslationsBean
where the translations must be of typebeanMappingClass
. This method never returnsnull
-
getRepresentationId
Description copied from interface:IdentifiableContentBean
The representational id for aIdentifiableContentBean
is by default equal to theIdentifiableContentBean.getIdentifier()
however implementations can change choose to return another id than theIdentifiableContentBean.getIdentifier()
. An example of a subclass (interface) returning a different value is for example theHippoDocumentBean
, since this one does return forIdentifiableContentBean.getRepresentationId()
the id of the backing JCR handle uuid instead of the uuid of the document variant.- Specified by:
getRepresentationId
in interfaceIdentifiableContentBean
- Returns:
- the representational id for this
IdentifiableContentBean
-