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    /** Returns the configuration for "Did you mean ...?".
038     * @return The configuration for "Did you mean ...?".
039     */
040    I_CmsSearchConfigurationDidYouMean getDidYouMeanConfig();
041
042    /** Returns the configuration for field facets.
043     * @return The configuration for field facets.
044     */
045    Map<String, I_CmsSearchConfigurationFacetField> getFieldFacetConfigs();
046
047    /** Returns the common search (form) configuration.
048     * @return The common search (form) configuration.
049     */
050    I_CmsSearchConfigurationCommon getGeneralConfig();
051
052    /** Returns the configuration for highlighting.
053     * @return The configuration for highlighting.
054     */
055    I_CmsSearchConfigurationHighlighting getHighlighterConfig();
056
057    /** Returns the configuration for pagination.
058     * @return The configuration for pagination.
059     */
060    I_CmsSearchConfigurationPagination getPaginationConfig();
061
062    /** Returns the configuration for field facets.
063     * @return The configuration for field facets.
064     */
065    I_CmsSearchConfigurationFacetQuery getQueryFacetConfig();
066
067    /** Returns the configuration for range facets.
068     * @return The configuration for range facets.
069     */
070    Map<String, I_CmsSearchConfigurationFacetRange> getRangeFacetConfigs();
071
072    /** Returns the configuration for sorting.
073     * @return The configuration for sorting.
074     */
075    I_CmsSearchConfigurationSorting getSortConfig();
076}