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.List;
031
032/** The interface a sort configuration must implement. */
033public interface I_CmsSearchConfigurationSorting {
034
035    /** Returns the sort configuration that is used as default.
036     * @return The sort configuration that is used as default.
037     */
038    I_CmsSearchConfigurationSortOption getDefaultSortOption();
039
040    /** Returns the configurations of all available sort options.
041     * @return The configurations of all available sort options.
042     */
043    List<I_CmsSearchConfigurationSortOption> getSortOptions();
044
045    /** Returns the request parameter that should be used to send the currently chosen sort option.
046     * @return The request parameter that should be used to send the currently chosen sort option.
047     */
048    String getSortParam();
049}