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.controller;
029
030/** Interface for the main search controller. Allows access to the various sub-controllers. */
031public interface I_CmsSearchControllerMain extends I_CmsSearchController {
032
033    /** Returns the controller for common search (form) configurations.
034     *
035     * @return The controller for common search (form) configurations.
036     */
037    I_CmsSearchControllerCommon getCommon();
038
039    /** Returns the controller for "Did you mean ...?".
040     * @return The controller for "Did you mean ...?".
041     */
042    I_CmsSearchControllerDidYouMean getDidYouMean();
043
044    /** Returns the controller for field facets.
045     *
046     * @return The controller for field facets.
047     */
048    I_CmsSearchControllerFacetsField getFieldFacets();
049
050    /**
051     * Returns the controller for the Geo filter.
052     * @return the controller for the Geo filter
053     */
054    I_CmsSearchControllerGeoFilter getGeoFilter();
055
056    /** Returns the controller for highlighting.
057         * @return The controller for highlighting.
058         */
059    I_CmsSearchControllerHighlighting getHighlighting();
060
061    /** Returns the controller for pagination.
062    * @return The controller for highlighting.
063    */
064    I_CmsSearchControllerPagination getPagination();
065
066    /** Returns the controller for the query facet.
067    *
068    * @return The controller for the query facet.
069    */
070    I_CmsSearchControllerFacetQuery getQueryFacet();
071
072    /** Returns the controller for range facets.
073    *
074    * @return The controller for range facets.
075    */
076    I_CmsSearchControllerFacetsRange getRangeFacets();
077
078    /** Returns the controller for sorting.
079     * @return The controller for sorting.
080     */
081    I_CmsSearchControllerSorting getSorting();
082}