Interface I_CmsSearchController
-
- All Known Subinterfaces:
I_CmsSearchControllerCommon
,I_CmsSearchControllerDidYouMean
,I_CmsSearchControllerFacetField
,I_CmsSearchControllerFacetQuery
,I_CmsSearchControllerFacetRange
,I_CmsSearchControllerFacetsField
,I_CmsSearchControllerFacetsRange
,I_CmsSearchControllerGeoFilter
,I_CmsSearchControllerHighlighting
,I_CmsSearchControllerMain
,I_CmsSearchControllerPagination
,I_CmsSearchControllerSorting
- All Known Implementing Classes:
CmsSearchController
,CmsSearchControllerCommon
,CmsSearchControllerDidYouMean
,CmsSearchControllerFacetField
,CmsSearchControllerFacetQuery
,CmsSearchControllerFacetRange
,CmsSearchControllerFacetsField
,CmsSearchControllerFacetsRange
,CmsSearchControllerGeoFilter
,CmsSearchControllerHighlighting
,CmsSearchControllerPagination
,CmsSearchControllerSorting
public interface I_CmsSearchController
Interface all search controllers must implement. It consists of methods for query generation and state updates.
-
-
Field Summary
Fields Modifier and Type Field Description static java.util.List<java.lang.String>
SET_VARIABLES
Solr query params that can have only one value.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description void
addParametersForCurrentState(java.util.Map<java.lang.String,java.lang.String[]> parameters)
Add the request parameters that reflect the controllers current state (useful for link generation outside of a form).default void
addQueryParts(CmsSolrQuery query)
Deprecated.useaddQueryParts(CmsSolrQuery, CmsObject)
instead.void
addQueryParts(CmsSolrQuery query, CmsObject cms)
Generate the Solr query part specific for the controller, e.g., the part for a field facet.void
updateForQueryChange()
Update the controllers state in case the term that is search for (the query as given by the user) has changed.void
updateFromRequestParameters(java.util.Map<java.lang.String,java.lang.String[]> parameters, boolean isRepeated)
Update the controllers state from the given request parameters.
-
-
-
Field Detail
-
SET_VARIABLES
static final java.util.List<java.lang.String> SET_VARIABLES
Solr query params that can have only one value.
-
-
Method Detail
-
addParametersForCurrentState
void addParametersForCurrentState(java.util.Map<java.lang.String,java.lang.String[]> parameters)
Add the request parameters that reflect the controllers current state (useful for link generation outside of a form).- Parameters:
parameters
- The request parameters reflecting the controllers currents state.
-
addQueryParts
@Deprecated default void addQueryParts(CmsSolrQuery query)
Deprecated.useaddQueryParts(CmsSolrQuery, CmsObject)
instead.Generate the Solr query part specific for the controller, e.g., the part for a field facet.- Parameters:
query
- A, possibly empty, query, where further query parts are added
-
addQueryParts
void addQueryParts(CmsSolrQuery query, CmsObject cms)
Generate the Solr query part specific for the controller, e.g., the part for a field facet.- Parameters:
query
- A, possibly empty, query, where further query parts are addedcms
- the current context to resolve context-specific macros.
-
updateForQueryChange
void updateForQueryChange()
Update the controllers state in case the term that is search for (the query as given by the user) has changed.
-
updateFromRequestParameters
void updateFromRequestParameters(java.util.Map<java.lang.String,java.lang.String[]> parameters, boolean isRepeated)
Update the controllers state from the given request parameters.- Parameters:
parameters
- The request parameters.isRepeated
- a flag, indicating, if the search is performed repeatedly, opposed to entering the search page for the first time.
-
-