org.opencms.jsp.search.config (OpenCms Core API, version 11.0.0)

Interface Summary
Interface	Description
I_CmsSearchConfiguration	Interface the main search configuration must implement.
I_CmsSearchConfigurationCommon	Interface the common search configuration must implement.
I_CmsSearchConfigurationDidYouMean	Interface of the "Did you mean ...?"
I_CmsSearchConfigurationFacet	Configuration common to all facets.
I_CmsSearchConfigurationFacetField	The interface a field facet configuration must implement.
I_CmsSearchConfigurationFacetQuery	Interface for the query facet configuration.
I_CmsSearchConfigurationFacetQuery.I_CmsFacetQueryItem	The interface of a single query facet item.
I_CmsSearchConfigurationFacetRange	The interface a field facet configuration must implement.
I_CmsSearchConfigurationHighlighting	The interface each highlighting configuration must implement.
I_CmsSearchConfigurationPagination	The interface a pagination configuration must implement.
I_CmsSearchConfigurationSorting	The interface a sort configuration must implement.
I_CmsSearchConfigurationSortOption	The interface a sort option configuration must implement.

Class Summary
Class	Description
CmsSearchConfiguration	The main search configuration.
CmsSearchConfigurationCommon	Search configuration for common parameters as the query parameter etc.
CmsSearchConfigurationDidYouMean	Class keeping the configuration of the "Did you mean ...?"
CmsSearchConfigurationFacet	Configuration that is common for all facets.
CmsSearchConfigurationFacetField	Search configuration special for field facets.
CmsSearchConfigurationFacetQuery	Configuration for the query facet.
CmsSearchConfigurationFacetQuery.CmsFacetQueryItem	Representation of one query facet item.
CmsSearchConfigurationFacetRange	Search configuration special for field facets.
CmsSearchConfigurationHighlighting	Search configuration for highlighting options.
CmsSearchConfigurationPagination	Search configuration for pagination.
CmsSearchConfigurationSorting	Configuration for sorting in general.
CmsSearchConfigurationSortOption	Configuration for a single sort option.

Enum Summary
Enum Description

I_CmsSearchConfigurationFacet.SortOrder
Sort orders available for Solr facet entries.

I_CmsSearchConfigurationFacetRange.Other

Enum Summary
Enum	Description
I_CmsSearchConfigurationFacet.SortOrder	Sort orders available for Solr facet entries.
I_CmsSearchConfigurationFacetRange.Other

Package org.opencms.jsp.search.config Description

API classes for the configuration of the search form support provided for server-side Solr search.

The search form support allows to create a search form just by configuring your search via an XML content or a JSON file. This package contains the classes that make up the configuration. The concrete types and their signature are defined in this package.

Since:: 10.0