atg.endeca.assembler.cartridge.handler

Class ResultsListHandler

java.lang.Object

com.endeca.infront.cartridge.NavigationCartridgeHandler<Config,Model>

com.endeca.infront.cartridge.ResultsListHandler

atg.endeca.assembler.cartridge.handler.ResultsListHandler

All Implemented Interfaces:

com.endeca.infront.assembler.CartridgeHandler<com.endeca.infront.cartridge.ResultsListConfig>

public class ResultsListHandler
extends com.endeca.infront.cartridge.ResultsListHandler

An overridden ResultsListHandler with an additional sorters property. The sorters property is an array of type com.endeca.infront.cartridge.model.SortOptionConfig. The property to perform a sort according to is set on the SortOptionConfig. When the sorters property is set, the sortOptions property is set to the components in the sorters array.

This extension is necessary as Nucleus does not support lists of components, where as the Assembler API requires it.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
ResultsListHandler()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	combineFieldNames(com.endeca.infront.navigation.NavigationState arg0, com.endeca.infront.cartridge.FieldNamesConfig arg1)
protected java.util.List<com.endeca.infront.cartridge.model.Record>	createRecords(com.endeca.navigation.ENEQueryResults arg0, com.endeca.infront.navigation.NavigationState arg1, com.endeca.infront.cartridge.FieldNamesConfig arg2)
com.endeca.infront.cartridge.model.SortOptionConfig[]	getSorters()
protected static long	getTotalNumRecs(com.endeca.navigation.ENEQueryResults arg0)
void	setSorters(com.endeca.infront.cartridge.model.SortOptionConfig[] pSorters) Sets sortOptions and sorters to the components referenced in pSorters.

Methods inherited from class com.endeca.infront.cartridge.ResultsListHandler

dispatchNavigationEventInformation, getSortOptions, initialize, preprocess, process, retainFields, setSortOptions, wrapConfig

Methods inherited from class com.endeca.infront.cartridge.NavigationCartridgeHandler

createMdexRequest, dispatchNavigationEventInformation, executeMdexRequest, executeMdexRequest, getActionPathProvider, getContentItemInitializer, getMdexRequestBroker, getNavigationState, getSiteState, getUserState, populateNavigationPathDefaults, setActionPathProvider, setContentItemInitializer, setMdexRequestBroker, setNavigationState, setSiteState, setUserState

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ResultsListHandler

public ResultsListHandler()

Method Detail

getSorters

public com.endeca.infront.cartridge.model.SortOptionConfig[] getSorters()

Returns:

An array of SortOptionConfig components.

setSorters

public void setSorters(com.endeca.infront.cartridge.model.SortOptionConfig[] pSorters)

Sets sortOptions and sorters to the components referenced in pSorters.

Parameters:

pSorters - - the SortOptionConfigs

combineFieldNames

protected java.util.List<java.lang.String> combineFieldNames(com.endeca.infront.navigation.NavigationState arg0,
                                                             com.endeca.infront.cartridge.FieldNamesConfig arg1)
                                                      throws com.endeca.infront.assembler.CartridgeHandlerException

Throws:

com.endeca.infront.assembler.CartridgeHandlerException

getTotalNumRecs

protected static long getTotalNumRecs(com.endeca.navigation.ENEQueryResults arg0)

createRecords

protected java.util.List<com.endeca.infront.cartridge.model.Record> createRecords(com.endeca.navigation.ENEQueryResults arg0,
                                                                                  com.endeca.infront.navigation.NavigationState arg1,
                                                                                  com.endeca.infront.cartridge.FieldNamesConfig arg2)