001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.jsp.search.config;
029
030import java.util.Map;
031
032/** Interface the main search configuration must implement.
033 * It basically allows to access the various configuration parts.
034 */
035public interface I_CmsSearchConfiguration {
036
037    /**
038     * Extends the search configuration with another given configuration.
039     * @param extensionConfig the extension to add.
040     */
041    void extend(I_CmsSearchConfiguration extensionConfig);
042
043    /** Returns the configuration for "Did you mean ...?".
044     * @return The configuration for "Did you mean ...?".
045     */
046    I_CmsSearchConfigurationDidYouMean getDidYouMeanConfig();
047
048    /** Returns the configuration for field facets.
049     * @return The configuration for field facets.
050     */
051    Map<String, I_CmsSearchConfigurationFacetField> getFieldFacetConfigs();
052
053    /** Returns the common search (form) configuration.
054     * @return The common search (form) configuration.
055     */
056    I_CmsSearchConfigurationCommon getGeneralConfig();
057
058    /** Returns the Geo filter configuration.
059     * @return The Geo filter configuration.
060     */
061    I_CmsSearchConfigurationGeoFilter getGeoFilterConfig();
062
063    /** Returns the configuration for highlighting.
064     * @return The configuration for highlighting.
065     */
066    I_CmsSearchConfigurationHighlighting getHighlighterConfig();
067
068    /** Returns the configuration for pagination.
069     * @return The configuration for pagination.
070     */
071    I_CmsSearchConfigurationPagination getPaginationConfig();
072
073    /** Returns the configuration for field facets.
074     * @return The configuration for field facets.
075     */
076    I_CmsSearchConfigurationFacetQuery getQueryFacetConfig();
077
078    /** Returns the configuration for range facets.
079     * @return The configuration for range facets.
080     */
081    Map<String, I_CmsSearchConfigurationFacetRange> getRangeFacetConfigs();
082
083    /** Returns the configuration for sorting.
084     * @return The configuration for sorting.
085     */
086    I_CmsSearchConfigurationSorting getSortConfig();
087}