org.opencms.jsp.search.config

Interface I_CmsSearchConfiguration

All Known Implementing Classes:

CmsSearchConfiguration

public interface I_CmsSearchConfiguration

Interface the main search configuration must implement. It basically allows to access the various configuration parts.

Method Summary

Modifier and Type	Method and Description
I_CmsSearchConfigurationDidYouMean	getDidYouMeanConfig() Returns the configuration for "Did you mean ...?".
java.util.Map<java.lang.String,I_CmsSearchConfigurationFacetField>	getFieldFacetConfigs() Returns the configuration for field facets.
I_CmsSearchConfigurationCommon	getGeneralConfig() Returns the common search (form) configuration.
I_CmsSearchConfigurationHighlighting	getHighlighterConfig() Returns the configuration for highlighting.
I_CmsSearchConfigurationPagination	getPaginationConfig() Returns the configuration for pagination.
I_CmsSearchConfigurationFacetQuery	getQueryFacetConfig() Returns the configuration for field facets.
java.util.Map<java.lang.String,I_CmsSearchConfigurationFacetRange>	getRangeFacetConfigs() Returns the configuration for range facets.
I_CmsSearchConfigurationSorting	getSortConfig() Returns the configuration for sorting.

Method Detail

getDidYouMeanConfig

I_CmsSearchConfigurationDidYouMean getDidYouMeanConfig()

Returns the configuration for "Did you mean ...?".

Returns:

The configuration for "Did you mean ...?".

getFieldFacetConfigs

java.util.Map<java.lang.String,I_CmsSearchConfigurationFacetField> getFieldFacetConfigs()

Returns the configuration for field facets.

Returns:

The configuration for field facets.

getGeneralConfig

I_CmsSearchConfigurationCommon getGeneralConfig()

Returns the common search (form) configuration.

Returns:

The common search (form) configuration.

getHighlighterConfig

I_CmsSearchConfigurationHighlighting getHighlighterConfig()

Returns the configuration for highlighting.

Returns:

The configuration for highlighting.

getPaginationConfig

I_CmsSearchConfigurationPagination getPaginationConfig()

Returns the configuration for pagination.

Returns:

The configuration for pagination.

getQueryFacetConfig

I_CmsSearchConfigurationFacetQuery getQueryFacetConfig()

Returns the configuration for field facets.

Returns:

The configuration for field facets.

getRangeFacetConfigs

java.util.Map<java.lang.String,I_CmsSearchConfigurationFacetRange> getRangeFacetConfigs()

Returns the configuration for range facets.

Returns:

The configuration for range facets.

getSortConfig

I_CmsSearchConfigurationSorting getSortConfig()

Returns the configuration for sorting.

Returns:

The configuration for sorting.