Uses of Class
org.opencms.search.CmsSearchParameters

Packages that use CmsSearchParameters

Package	Description
org.opencms.search	Implements the main full text search and indexing functions available in OpenCms.
org.opencms.search.documents	Handles indexing different sorts of document and resource type from the OpenCms VFS for the full text search.
org.opencms.search.solr	The package contains the Solr search integration.

Uses of CmsSearchParameters in org.opencms.search

Fields in org.opencms.search declared as CmsSearchParameters

Modifier and Type	Field	Description
protected CmsSearchParameters	CmsSearch.m_parameterRestriction	The restriction for the search parameters, used for "search in search result".
protected CmsSearchParameters	CmsSearch.m_parameters	The search parameters used for searching, build out of the given individual parameter values.

Methods in org.opencms.search that return CmsSearchParameters

Modifier and Type	Method	Description
CmsSearchParameters	CmsSearch.getParameters()	Returns the search parameters used for searching, build out of the given individual parameter values.
CmsSearchParameters	CmsSearchParameters.restrict(CmsSearchParameters restriction)	Creates a merged parameter set from this parameters, restricted by the given other parameters.

Methods in org.opencms.search with parameters of type CmsSearchParameters

Modifier and Type	Method	Description
protected boolean	CmsSearchIndex.isInTimeRange(org.apache.lucene.document.Document doc, CmsSearchParameters params)	Checks if the document is in the time range specified in the search parameters.
CmsSearchParameters	CmsSearchParameters.restrict(CmsSearchParameters restriction)	Creates a merged parameter set from this parameters, restricted by the given other parameters.
CmsSearchResultList	CmsSearchIndex.search(CmsObject cms, CmsSearchParameters params)	Performs a search on the index within the given fields.
void	CmsSearch.setParameters(CmsSearchParameters parameters)	Set the parameters to use if a non null instance is provided.
void	CmsSearch.setResultRestriction(CmsSearchParameters restriction)	Restrict the result of the next search to the results of the last search, restricted with the provided parameters.

Uses of CmsSearchParameters in org.opencms.search.documents

Methods in org.opencms.search.documents with parameters of type CmsSearchParameters

Modifier and Type	Method	Description
String	CmsTermHighlighterHtml.getExcerpt(org.apache.lucene.document.Document doc, CmsSearchIndex index, CmsSearchParameters params, org.apache.lucene.search.Query query, org.apache.lucene.analysis.Analyzer analyzer)
String	I_CmsTermHighlighter.getExcerpt(org.apache.lucene.document.Document doc, CmsSearchIndex index, CmsSearchParameters params, org.apache.lucene.search.Query query, org.apache.lucene.analysis.Analyzer analyzer)	Returns an excerpt of the given document related based on the given index and query.

Uses of CmsSearchParameters in org.opencms.search.solr

Methods in org.opencms.search.solr with parameters of type CmsSearchParameters

Modifier and Type	Method	Description
CmsSearchResultList	CmsSolrIndex.search(CmsObject cms, CmsSearchParameters params)	Deprecated. Use CmsSolrIndex.search(CmsObject, SolrQuery) or CmsSolrIndex.search(CmsObject, String) instead