com.endeca.navigation
Class Supplement

java.lang.Object
  com.endeca.navigation.Supplement

All Implemented Interfaces:

PropertyContainer

public class Supplement
extends Object
implements PropertyContainer

Class representing supplemental information and data for a navigation query.

Method Summary

ERecList	getERecs() Gets the Endeca records of this Supplement.
NavigationRefsList	getNavigationRefs() Gets the navigation state queries referenced by this Supplement.
PropertyMap	getProperties() Gets the properties of this Supplement.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getProperties

public PropertyMap getProperties()

Gets the properties of this Supplement. Returns an empty set of properties if there are no properties associated with this Supplement.

Specified by:

getProperties in interface PropertyContainer

Returns:

PropertyMap object containing the properties of this Supplement.

getERecs

public ERecList getERecs()

Gets the Endeca records of this Supplement. Returns an empty record list if there are no records associated with this Supplement.

Returns:

ERecList object encapsulating the Endeca records (ERec objects) of this Supplement.

getNavigationRefs

public NavigationRefsList getNavigationRefs()

Gets the navigation state queries referenced by this Supplement. Returns an empty dimension value list if there are no navigation state references.

Returns:

NavigationRefsList object encapsulating the navigation references of this Supplement.