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
030/** Interface of the "Did you mean ...?" configuration for the JSP search form. */
031public interface I_CmsSearchConfigurationDidYouMean {
032
033    /** Returns a flag, indicating if collation is turned on or off.
034     * @return A flag, indicating if collation is turned on or off.
035     */
036    boolean getCollate();
037
038    /** Returns the maximal number of suggestions.
039     * @return The maximal number of suggestions.
040     */
041    int getCount();
042
043    /** Returns the parameter name of the request parameter used to send the current query string for spellchecking.
044     * @return The request parameter name used to send the current query string for spellchecking.
045     */
046    String getQueryParam();
047}