Uses of Interface
com.endeca.infront.navigation.NavigationState

Packages that use NavigationState

Package	Description
com.endeca.infront.cartridge	Contains the built-in Assembler cartridge handlers and their configuration classes.
com.endeca.infront.content	Contains all interfaces for accessing and representing content in an Assembler Application.
com.endeca.infront.navigation	Contains classes and interfaces for making requests to an MDEX server.
com.endeca.infront.navigation.event	The interface to create navigation related RequestEvent objects and log them to an Oracle Endeca log server
com.endeca.infront.navigation.url	Contains URL-based implementations of the interfaces in com.endeca.infront.navigation for making requests to an MDEX server.

Uses of NavigationState in com.endeca.infront.cartridge

Methods in com.endeca.infront.cartridge that return NavigationState

Modifier and Type	Method and Description
protected NavigationState	DimensionSearchResultsHandler.createDimensionSearchNavigationState(NavigationState navigationState) Takes the global NavigationState and returns the NavigationState that gets used to submit the dimension search query.
protected NavigationState	RecordSpotlightHandler.createSpotlightNavigationState(NavigationState navigationState, RecordSpotlightConfig config) This method is responsible for merging the global NavigationState passed in with the RecordSpotlightConfig's navigation selection.
NavigationState	NavigationCartridgeHandler.getNavigationState() Gets the navigation state represented by the current request.

Methods in com.endeca.infront.cartridge with parameters of type NavigationState

Modifier and Type	Method and Description
protected NavigationState	DimensionSearchResultsHandler.createDimensionSearchNavigationState(NavigationState navigationState) Takes the global NavigationState and returns the NavigationState that gets used to submit the dimension search query.
protected NavigationState	RecordSpotlightHandler.createSpotlightNavigationState(NavigationState navigationState, RecordSpotlightConfig config) This method is responsible for merging the global NavigationState passed in with the RecordSpotlightConfig's navigation selection.
protected SearchFilter	DimensionSearchResultsHandler.getDimensionSearchFilter(NavigationState navigationState) Gets the SearchFilter used for the dimension search.
protected FilterState	RecordDetailsHandler.getFilterState(NavigationState navigationState) Retrieves the filter state to use when making record detail queries.
protected RecordSpotlight	RecordSpotlightHandler.processSpotlightMdexResponse(NavigationState spotlightNavigationState, RecordSpotlightConfig config, com.endeca.navigation.ENEQueryResults eneResults) Protected method allows this to be overridden by subclasses of the CartridgeHandler.
void	RedirectAwareContentIncludeHandler.setNavigationState(NavigationState navigationState) The navigation state for this request.
void	NavigationCartridgeHandler.setNavigationState(NavigationState pNavigationState) Sets the navigation state represented by the current request.

Uses of NavigationState in com.endeca.infront.content

Fields in com.endeca.infront.content declared as NavigationState

Modifier and Type	Field and Description
protected NavigationState	MdexContentRequestBroker.mNavigationState

Constructors in com.endeca.infront.content with parameters of type NavigationState

Constructor and Description
MdexContentRequestBroker(MdexResource pMdexResource, NavigationState pNavigationState, UserState pUserState, boolean pAuditEnabled) Builds an MDEX Content Request Broker

Uses of NavigationState in com.endeca.infront.navigation

Methods in com.endeca.infront.navigation that return NavigationState

Modifier and Type	Method and Description
NavigationState	NavigationState.augment(FilterState filterState) Create a new NavigationState relative to this one, augmented with the specified FilterState object.
NavigationState	NavigationState.clearFilterState() Create a new NavigationState relative to this one, clearing the FilterState object of the following: FilterState.getSearchFilters() - clears to an empty list FilterState.getNavigationFilters() - clears to an empty list FilterState.getRangeFilters() - clears to an empty list FilterState.getRecordFilters() - clears to an empty list FilterState.getFeaturedRecords() - clears to an empty list FilterState.getGeoFilter() - clears to null
NavigationState	NavigationState.clearGeoFilter() Create a new NavigationState relative to this one, removing the geo filter.
NavigationState	NavigationState.clearNavigationFilters() Create a new NavigationState relative to this one, clearing the navigation filters.
NavigationState	NavigationState.clearParameters() Create a new NavigationState relative to this one, clearing the parameters map.
NavigationState	NavigationState.clearRangeFilters() Create a new NavigationState relative to this one, removing the range filters.
NavigationState	NavigationState.clearRecordFilters() Create a new NavigationState relative to this one, removing the record filters.
NavigationState	NavigationState.clearSearchFilters() Create a new NavigationState relative to this one, removing the searches.
NavigationState	NavigationStateBuilder.parseNavigationState(String queryString, String pathInfo, String characterEncoding) Create a NavigationState parsed from a query string, a path info, and a character encoding.
NavigationState	NavigationState.putAllParameters(Map<String,String> parameters) Create a new NavigationState relative to this one, updating all of the specified parameters.
NavigationState	NavigationState.putParameter(String name, String value) Create a new NavigationState relative to this one, updating the specified parameter.
NavigationState	NavigationState.removeNavigationFilter(String dvalId) Create a new NavigationState relative to this one, removing the specified navigation filter.
NavigationState	NavigationState.removeParameter(String name) Create a new NavigationState relative to this one, removing the specified parameter.
NavigationState	NavigationState.selectNavigationFilter(String dvalId) Create a new NavigationState relative to this one, selecting the specified navigation filter.
NavigationState	NavigationState.updateFilterState(FilterState filterState) Create a new NavigationState relative to this one, replacing the existing FilterState object with the given one.
NavigationState	NavigationState.updateGeoFilter(GeoFilter geoFilter) Create a new NavigationState relative to this one, with the existing GeoFilter (if any) replaced by the given one.
NavigationState	NavigationState.updateParameters(Map<String,String> parameters) Create a new NavigationState relative to this one, replacing the entire existing parameter map with the given one.
NavigationState	NavigationState.updateRangeFilters(List<RangeFilter> rangeFilters) Create a new NavigationState relative to this one, with any existing range filters replaced by those in the given list.
NavigationState	NavigationState.updateRecordFilters(List<String> recordFilters) Create a new NavigationState relative to this one, with any existing record filters replaced by those in the given list.
NavigationState	NavigationState.updateSearchFilters(List<SearchFilter> searchFilters) Create a new NavigationState relative to this one, with any existing search filters replaced by those in the given list.

Uses of NavigationState in com.endeca.infront.navigation.event

Methods in com.endeca.infront.navigation.event with parameters of type NavigationState

Modifier and Type	Method and Description
static RequestType	RequestType.deriveRequestType(NavigationState navigationState) Attempt to infer the type of page request from a given navigation state.

Uses of NavigationState in com.endeca.infront.navigation.url

Methods in com.endeca.infront.navigation.url that return NavigationState

Modifier and Type	Method and Description
NavigationState	UrlNavigationStateBuilder.parseNavigationState(javax.servlet.http.HttpServletRequest request) Creates a NavigationState using the query string, path info, and character encoding from the given request object.
NavigationState	UrlNavigationStateBuilder.parseNavigationState(String queryString, String pathInfo, String characterEncoding)

Methods in com.endeca.infront.navigation.url with parameters of type NavigationState

Modifier and Type	Method and Description
protected void	UrlNavigationStateBuilder.addAutoPhraseEnabled(NavigationState navigationState, UrlState urlState) Updates the UrlState, adding the autophraseParam if the current value of FilterState.isAutoPhraseEnabled() is different from the defaultFilterState.
protected void	UrlNavigationStateBuilder.addEqlFilter(NavigationState navigationState, UrlState urlState) Updates the UrlState, adding the eqlparam if the current value of FilterState.getEqlFilter() is different from the defaultFilterState.
protected void	UrlNavigationStateBuilder.addFeaturedRecords(NavigationState navigationState, UrlState urlState) Updates the UrlState by adding featured records from the given NavigationState.
protected void	UrlNavigationStateBuilder.addGeoFilter(NavigationState navigationState, UrlState urlState) Updates the UrlState by adding a geo filter from the given NavigationState.
protected void	UrlNavigationStateBuilder.addLanguageId(NavigationState navigationState, UrlState urlState) Updates the UrlState, adding the languageParam if the current value of FilterState.getLanguageId() is different from the defaultFilterState.
protected void	UrlNavigationStateBuilder.addNavigationFilters(NavigationState navigationState, UrlState urlState) Updates the UrlState by adding navigation filters from the NavigationState.
protected void	UrlNavigationStateBuilder.addParameters(NavigationState navigationState, UrlState urlState) Updates the UrlState by adding URL parameters from the given NavigationState.
protected void	UrlNavigationStateBuilder.addRangeFilters(NavigationState navigationState, UrlState urlState) Updates the UrlState by adding range filters from the given NavigationState.
protected void	UrlNavigationStateBuilder.addRecordFilters(NavigationState navigationState, UrlState urlState) Updates the UrlState by adding record filters from the given NavigationState
protected void	UrlNavigationStateBuilder.addSearchFilters(NavigationState navigationState, UrlState urlState) Updates the UrlState by adding search filters from the given NavigationState.
UrlState	UrlNavigationStateBuilder.buildUrlState(NavigationState navigationState)