HippoFacetNavigationBean (Hippo Site Toolkit API 15.2.0 API)

All Superinterfaces:

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

All Known Subinterfaces:

HippoFacetChildNavigationBean
```
public interface HippoFacetNavigationBean
extends HippoFolderBean
```
Interface for all nodes of type 'hippo:facetnavigation'

Field Summary
- Fields inherited from interface org.hippoecm.hst.content.beans.standard.HippoBean
  log

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Long`	`getChildCountsCombined()`	Return all the hippo:count values of all child HippoFacetNavigationBean combined.
`Long`	`getCount()`	the value of the 'hippo:count' property
`HippoResultSetBean`	`getResultSet()`
`HippoFacetNavigationBean`	`getRootFacetNavigationBean()`

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.HippoFolderBean
getDocumentIterator, getDocuments, getDocuments, getDocuments, getDocuments, getDocuments, getDocumentSize, getFolders, getFolders

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, getRepresentationId, 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
  - getCount
```
Long getCount()
```
    the value of the 'hippo:count' property
    
    Returns:
    
    Long value for the count
  - getChildCountsCombined
```
Long getChildCountsCombined()
```
    Return all the hippo:count values of all child HippoFacetNavigationBean combined. This count can be different from the getCount() of this HippoFacetNavigationBean because of two reasons:
    
    A document in the resultset can belong to multiple child HippoFacetNavigationBean's
    
    A document in the resultset can belong to zero child HippoFacetNavigationBean's: this happens for example when the document has a property, say 'my:date' , but its date does not belong to any of the ranges that the child HippoFacetNavigationBean represent
    Returns:
    
    Return all the hippo:count values of all child HippoFacetNavigationBean combined.
  - getResultSet
```
HippoResultSetBean getResultSet()
```
    Returns:
    
    the result set below this faceted navigation item and null is there is no resultset node, for example when the count is 0
  - getRootFacetNavigationBean
```
HippoFacetNavigationBean getRootFacetNavigationBean()
```
    Returns:
    
    the root facetNavigationBean of this HippoFacetNavigationBean. If this HippoFacetNavigationBean is a HippoFacetChildNavigationBean it returns the root, otherwise it might return itself.