Package org.hippoecm.hst.content.beans.standard

Interface HippoDocumentBean

All Superinterfaces:

Comparable<HippoBean>, ContentBean, HippoBean, HippoTranslated, IdentifiableContentBean, NodeAware, ObjectConverterAware, PageModelEntity

public interface HippoDocumentBean
extends HippoBean, HippoTranslated, 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

Fields inherited from interface org.hippoecm.hst.content.beans.standard.HippoBean

log

Method Summary

Modifier and Type	Method	Description
<T extends HippoBean> HippoAvailableTranslationsBean<T>	getAvailableTranslations(Class<T> beanMappingClass)
String	getCanonicalHandlePath()	Returns the jcr path of the backing canonical handle jcr node or null when
String	getCanonicalHandleUUID()	Returns the jcr uuid of the backing canonical handle jcr node or null when
default String	getRepresentationId()	The representational id for a IdentifiableContentBean is by default equal to the IdentifiableContentBean.getIdentifier() however implementations can change choose to return another id than the IdentifiableContentBean.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.NodeAware

setNode

Methods inherited from interface org.hippoecm.hst.content.beans.manager.ObjectConverterAware

getObjectConverter, setObjectConverter

Method Detail

getCanonicalHandleUUID

String getCanonicalHandleUUID()

Returns the jcr uuid of the backing canonical handle jcr node or null 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:

HippoBean.getCanonicalUUID()

getCanonicalHandlePath

String getCanonicalHandlePath()

Returns the jcr path of the backing canonical handle jcr node or null 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:

HippoBean.getCanonicalPath()

getAvailableTranslations

<T extends HippoBean> HippoAvailableTranslationsBean<T> getAvailableTranslations(Class<T> beanMappingClass)

Parameters:

beanMappingClass - only return translations of type beanMappingClass

Returns:

a HippoAvailableTranslationsBean where the translations must be of type beanMappingClass. This method never returns null

getRepresentationId

default String getRepresentationId()

Description copied from interface: IdentifiableContentBean

The representational id for a IdentifiableContentBean is by default equal to the IdentifiableContentBean.getIdentifier() however implementations can change choose to return another id than the IdentifiableContentBean.getIdentifier(). An example of a subclass (interface) returning a different value is for example the HippoDocumentBean, since this one does return for IdentifiableContentBean.getRepresentationId() the id of the backing JCR handle uuid instead of the uuid of the document variant.

Specified by:

getRepresentationId in interface IdentifiableContentBean

Returns:

the representational id for this IdentifiableContentBean