|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.infront.cartridge.NavigationCartridgeHandler<DimensionSearchResultsConfig,DimensionSearchResults> com.endeca.infront.cartridge.DimensionSearchResultsHandler
public class DimensionSearchResultsHandler
Cartridge handler that creates DimensionSearchResults
model objects.
Constructor Summary | |
---|---|
DimensionSearchResultsHandler()
|
Method Summary | |
---|---|
protected NavigationState |
createDimensionSearchNavigationState(NavigationState navigationState)
Takes the global NavigationState and returns the NavigationState that gets used to submit the dimension search query. |
protected SearchFilter |
getDimensionSearchFilter(NavigationState navigationState)
Gets the SearchFilter used for the dimension search. |
void |
preprocess(DimensionSearchResultsConfig cartridgeConfig)
Creates a dimension search query if DimensionSearchResultsConfig.isEnabled()
returns true. |
DimensionSearchResults |
process(DimensionSearchResultsConfig cartridgeConfig)
Returns a DimensionSearchResults if DimensionSearchResultsConfig.isEnabled() is true,
and there is at least 1 search term in the NavigationState
else returns null. |
protected DimensionSearchResultsConfig |
wrapConfig(ContentItem pContentItem)
Wraps the input ContentItem as a typed config object. |
Methods inherited from class com.endeca.infront.cartridge.NavigationCartridgeHandler |
---|
createMdexRequest, dispatchNavigationEventInformation, executeMdexRequest, getActionPathProvider, getContentItemInitializer, getMdexRequestBroker, getNavigationState, initialize, populateNavigationPathDefaults, setActionPathProvider, setContentItemInitializer, setMdexRequestBroker, setNavigationState |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DimensionSearchResultsHandler()
Method Detail |
---|
protected DimensionSearchResultsConfig wrapConfig(ContentItem pContentItem)
NavigationCartridgeHandler
ContentItem
as a typed config object. It is not expected that
subclasses will mutate the input ContentItem
, beyond passing it into
their typed configuration class as a constructor argument.
wrapConfig
in class NavigationCartridgeHandler<DimensionSearchResultsConfig,DimensionSearchResults>
pContentItem
- the configuration for this cartridge handler. This will either be the
fully initialized configuration object, if a ContentItemInitializer
has been
set, or it will simply be the instance configuration.
ConfigType
which wraps the input ContentItem
.NavigationCartridgeHandler.initialize(ContentItem)
,
NavigationCartridgeHandler.setContentItemInitializer(ContentItemInitializer)
public void preprocess(DimensionSearchResultsConfig cartridgeConfig) throws CartridgeHandlerException
DimensionSearchResultsConfig.isEnabled()
returns true.
preprocess
in interface CartridgeHandler<DimensionSearchResultsConfig>
preprocess
in class NavigationCartridgeHandler<DimensionSearchResultsConfig,DimensionSearchResults>
cartridgeConfig
- the cartridge configuration returned by
CartridgeHandler.initialize(ContentItem)
. This cartridge configuration may
be modified by this handler. Note that this cartridge configuration is
also passed to CartridgeHandler.process(ContentItem)
.
CartridgeHandlerException
- if an error occurs that is scoped to
an individual cartridge instance. This exception will not halt
the entire assembly process, which occurs across multiple cartridges;
instead, this exception will be packaged in the overall response model.
If an unchecked exception is thrown, then the entire assembly process
will be halted.protected SearchFilter getDimensionSearchFilter(NavigationState navigationState)
navigationState
- the global NavigationState objectprotected NavigationState createDimensionSearchNavigationState(NavigationState navigationState)
navigationState
- the global NavigationState object
public DimensionSearchResults process(DimensionSearchResultsConfig cartridgeConfig) throws CartridgeHandlerException
DimensionSearchResultsConfig.isEnabled()
is true,
and there is at least 1 search term in the NavigationState
else returns null.
process
in interface CartridgeHandler<DimensionSearchResultsConfig>
process
in class NavigationCartridgeHandler<DimensionSearchResultsConfig,DimensionSearchResults>
cartridgeConfig
- the cartridge configuration returned by
CartridgeHandler.initialize(ContentItem)
. Note that this instance may have been modified by
the CartridgeHandler.preprocess(ContentItem)
method.
CartridgeHandlerException
- if an error occurs that is scoped to
an individual cartridge instance. This exception will not halt
the entire assembly process, which occurs across multiple cartridges;
instead, this exception will be packaged in the overall response model.
If an unchecked exception is thrown, then the entire assembly process
will be halted.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |