ContextualNavigation (Plugin Shared 16.30.0-SNAPSHOT API)

java.lang.Object
- com.funnelback.publicui.search.model.padre.ContextualNavigation

```
public class ContextualNavigation
extends Object
```
Contextual navigation parent class.

Since:

11.0

See Also:

Category, Cluster, ClusterNav

Field Summary

Fields
Modifier and Type	Field	Description
`private List<Category>`	`categories`	List of categories (type, topic, site).
`private ClusterNav`	`clusterNav`	Navigation items
`private Map<String,Object>`	`customData`	Custom data placeholder allowing any arbitrary data to be stored by hook scripts.
`private String`	`searchTerm`	Terms used within this contextual navigation object

Constructor Summary

Constructors
Constructor Description

ContextualNavigation()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<Category>`	`getCategories()`	List of categories (type, topic, site).
`ClusterNav`	`getClusterNav()`	Navigation items
`Map<String,Object>`	`getCustomData()`	Custom data placeholder allowing any arbitrary data to be stored by hook scripts.
`String`	`getSearchTerm()`	Terms used within this contextual navigation object
`void`	`setClusterNav(ClusterNav clusterNav)`	Navigation items
`void`	`setSearchTerm(String searchTerm)`	Terms used within this contextual navigation object

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - searchTerm
```
private String searchTerm
```
    Terms used within this contextual navigation object
  - clusterNav
```
private ClusterNav clusterNav
```
    Navigation items
  - categories
```
private final List<Category> categories
```
    List of categories (type, topic, site).
  - customData
```
private final Map<String,Object> customData
```
    Custom data placeholder allowing any arbitrary data to be stored by hook scripts.
- Constructor Detail
  - ContextualNavigation
```
public ContextualNavigation()
```
- Method Detail
  - getSearchTerm
```
public String getSearchTerm()
```
    Terms used within this contextual navigation object
  - setSearchTerm
```
public void setSearchTerm(String searchTerm)
```
    Terms used within this contextual navigation object
  - getClusterNav
```
public ClusterNav getClusterNav()
```
    Navigation items
  - setClusterNav
```
public void setClusterNav(ClusterNav clusterNav)
```
    Navigation items
  - getCategories
```
public List<Category> getCategories()
```
    List of categories (type, topic, site).
  - getCustomData
```
public Map<String,Object> getCustomData()
```
    Custom data placeholder allowing any arbitrary data to be stored by hook scripts.