com.endeca.content.ene
Interface NavigationRecords

public interface NavigationRecords

The Property.getValue() for a Property that was configured to use a NavigationRecords tag.

This interface represents the subset of Navigation necessary to build a record list from the results.

The results contained in instances of this interface do not necessarily match the results that are contained in the root ENEQueryResults.getNavigation().

Since:

2.0.0

Version:

2.0.0

See Also:

Property, Property.getValue()

Method Summary

com.endeca.navigation.ERecSortKeyList	getActiveSortKeys() Gets the sort keys in use for this navigation.
com.endeca.navigation.AggrERecList	getAggrERecs() Gets the composite records associated with this navigation query, which come from the original records consolidated by a rollup key.
long	getAggrERecsOffset() Gets the offset of the first aggregated record in the aggregated record list with respect to the total number of aggregated records in the dataset that match this navigation query.
long	getAggrERecsPerPage() Gets the maximum number of aggregated records that could have been returned from a navigation query.
com.endeca.navigation.ERecList	getERecs() Gets the records associated with this navigation query.
long	getERecsOffset() Gets the offset of the first record in the endeca record list with respect to the total number of records in the dataset that match this navigation query.
long	getERecsPerPage() Gets the maximum number of records that could have been returned from a navigation query.
com.endeca.navigation.ERecRollupKeyList	getRollupKeys() Gets the rollup keys applicable for this navigation.
com.endeca.navigation.ERecSortKeyList	getSortKeys() Gets the sort keys applicable for this navigation.
long	getTotalNumAggrERecs() Gets the total number of aggregated records matching navigation query.
long	getTotalNumERecs() Gets the total number of records matching the navigation query.

Method Detail

getSortKeys

com.endeca.navigation.ERecSortKeyList getSortKeys()

Gets the sort keys applicable for this navigation.

Returns:

The sort keys.

See Also:

Navigation.getSortKeys()

getActiveSortKeys

com.endeca.navigation.ERecSortKeyList getActiveSortKeys()

Gets the sort keys in use for this navigation.

Returns:

The active sort keys.

See Also:

Navigation.getActiveSortKeys()

getERecs

com.endeca.navigation.ERecList getERecs()

Gets the records associated with this navigation query.

Returns:

The returned records

See Also:

Navigation.getERecs()

getERecsOffset

long getERecsOffset()

Gets the offset of the first record in the endeca record list with respect to the total number of records in the dataset that match this navigation query.

Returns:

The offset into the records

See Also:

Navigation.getERecsOffset()

getERecsPerPage

long getERecsPerPage()

Gets the maximum number of records that could have been returned from a navigation query.

Returns:

The maximum number of records

See Also:

ENEQuery.getNavNumERecs()

getTotalNumERecs

long getTotalNumERecs()

Gets the total number of records matching the navigation query.

Returns:

The total number of records

See Also:

Navigation.getTotalNumERecs()

getRollupKeys

com.endeca.navigation.ERecRollupKeyList getRollupKeys()

Gets the rollup keys applicable for this navigation.

Returns:

The used rollup keys

See Also:

Navigation.getRollupKeys()

getAggrERecs

com.endeca.navigation.AggrERecList getAggrERecs()

Gets the composite records associated with this navigation query, which come from the original records consolidated by a rollup key.

Returns:

The returned aggregate records

See Also:

Navigation.getAggrERecs()

getAggrERecsOffset

long getAggrERecsOffset()

Gets the offset of the first aggregated record in the aggregated record list with respect to the total number of aggregated records in the dataset that match this navigation query.

Returns:

The offset into the aggregate records

See Also:

Navigation.getAggrERecsOffset()

getAggrERecsPerPage

long getAggrERecsPerPage()

Gets the maximum number of aggregated records that could have been returned from a navigation query.

Returns:

The maximum number of aggregate records

See Also:

ENEQuery.getNavNumAggrERecs()

getTotalNumAggrERecs

long getTotalNumAggrERecs()

Gets the total number of aggregated records matching navigation query.

Returns:

The total number of aggregate records

See Also:

Navigation.getTotalNumAggrERecs()