org.hippoecm.hst.content.beans.standard
Interface HippoDocumentBean

All Superinterfaces:

Comparable<HippoBean>, HippoBean, HippoTranslated, NodeAware, ObjectConverterAware

All Known Implementing Classes:

HippoAsset, HippoDocument, HippoGalleryImageSet

public interface HippoDocumentBean
extends HippoBean, HippoTranslated

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

Method Summary

<T extends HippoBean> HippoAvailableTranslationsBean<T>	getAvailableTranslationsBean(Class<T> beanMappingClass) In case that there is no translation bean, a HippoAvailableTranslationsBean.NoopTranslationsBean is returned, to make sure you do not need null checks
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

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

equalCompare, getAvailableTranslationsBean, getBean, getBean, getCanonicalPath, getCanonicalUUID, getChildBeans, getChildBeans, getChildBeansByName, getChildBeansByName, getContextualBean, getContextualParentBean, getEqualComparator, getLinkedBean, getLinkedBeans, getLocalizedName, getName, getNode, getParentBean, getPath, getProperties, getProperty, getProperty, getProperty, getValueProvider, isAncestor, isDescendant, isHippoDocumentBean, isHippoFolderBean, isLeaf, isSelf

Methods inherited from interface org.hippoecm.hst.content.beans.NodeAware

setNode

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

getObjectConverter, setObjectConverter

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.hippoecm.hst.content.beans.standard.HippoTranslated

getLocale, getLocaleString

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()

getAvailableTranslationsBean

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

In case that there is no translation bean, a HippoAvailableTranslationsBean.NoopTranslationsBean is returned, to make sure you do not need null checks

Parameters:

beanMappingClass -

Returns:

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