org.opencms.jsp.search.result

Interface I_CmsSearchStateParameters

All Known Implementing Classes:

CmsSearchStateParameters

public interface I_CmsSearchStateParameters

Interface for the search state parameters.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,I_CmsSearchStateParameters>	getAddIgnoreFacetLimit() Returns the search state parameters with the parameter for ignoring a facet's (specified by first key) limit added.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,I_CmsSearchStateParameters>>	getCheckFacetItem() Returns the search state parameters with the filter query for facets (specified by first key) item (specified by the second key) added.
java.util.Map<java.lang.String,I_CmsSearchStateParameters>	getNewQuery() Returns the search state parameters with the Query parameter's value adjusted to the key of the map.
java.util.Map<java.lang.String,I_CmsSearchStateParameters>	getRemoveIgnoreFacetLimit() Returns the search state parameters with the parameter for ignoring a facet's (specified by first key) limit removed.
I_CmsSearchStateParameters	getResetAllFacetStates() Returns the search state parameters with all filter queries for facets removed.
java.util.Map<java.lang.String,I_CmsSearchStateParameters>	getResetFacetState() Returns the search state parameters with all filter queries for the facet specified as key removed.
java.util.Map<java.lang.String,I_CmsSearchStateParameters>	getSetPage() Returns the search state parameters with the value for the current page's parameter replaced by the key.
java.util.Map<java.lang.String,I_CmsSearchStateParameters>	getSetSortOption() Returns the search state parameters with the value for the sort parameter replaced by the key.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,I_CmsSearchStateParameters>>	getUncheckFacetItem() Returns the search state parameters with the filter query for facets (specified by first key) item (specified by the second key) removed.

Method Detail

getAddIgnoreFacetLimit

java.util.Map<java.lang.String,I_CmsSearchStateParameters> getAddIgnoreFacetLimit()

Returns the search state parameters with the parameter for ignoring a facet's (specified by first key) limit added.

Returns:

The search state parameters with the parameter for ignoring a facet's (specified by first key) limit added.

getCheckFacetItem

java.util.Map<java.lang.String,java.util.Map<java.lang.String,I_CmsSearchStateParameters>> getCheckFacetItem()

Returns the search state parameters with the filter query for facets (specified by first key) item (specified by the second key) added.

Returns:

The search state parameters with the filter query for facets (specified by first key) item (specified by the second key) added.

getNewQuery

java.util.Map<java.lang.String,I_CmsSearchStateParameters> getNewQuery()

Returns the search state parameters with the Query parameter's value adjusted to the key of the map.

Returns:

The search state parameters with the Query parameter's value adjusted to the key of the map.

getRemoveIgnoreFacetLimit

java.util.Map<java.lang.String,I_CmsSearchStateParameters> getRemoveIgnoreFacetLimit()

Returns the search state parameters with the parameter for ignoring a facet's (specified by first key) limit removed.

Returns:

The search state parameters with the parameter for ignoring a facet's (specified by first key) limit removed.

getResetAllFacetStates

I_CmsSearchStateParameters getResetAllFacetStates()

Returns the search state parameters with all filter queries for facets removed.

Returns:

The search state parameters with all filter queries for facets removed.

getResetFacetState

java.util.Map<java.lang.String,I_CmsSearchStateParameters> getResetFacetState()

Returns the search state parameters with all filter queries for the facet specified as key removed.

Returns:

The search state parameters with all filter queries for the facet specified as key removed.

getSetPage

java.util.Map<java.lang.String,I_CmsSearchStateParameters> getSetPage()

Returns the search state parameters with the value for the current page's parameter replaced by the key.

Returns:

The search state parameters with the value for the current page's parameter replaced by the key.

getSetSortOption

java.util.Map<java.lang.String,I_CmsSearchStateParameters> getSetSortOption()

Returns the search state parameters with the value for the sort parameter replaced by the key.

Returns:

The search state parameters with the value for the sort parameter replaced by the key.

getUncheckFacetItem

java.util.Map<java.lang.String,java.util.Map<java.lang.String,I_CmsSearchStateParameters>> getUncheckFacetItem()

Returns the search state parameters with the filter query for facets (specified by first key) item (specified by the second key) removed.

Returns:

The search state parameters with the filter query for facets (specified by first key) item (specified by the second key) removed.