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/** The interface a sort option configuration must implement. */ 031public interface I_CmsSearchConfigurationSortOption { 032 033 /** Returns the label that can be used to display the sort option in the form. 034 * @return The label that can be used to display the sort option in the form. 035 */ 036 String getLabel(); 037 038 /** Returns the request parameter's value that has to be send to choose that sort option. 039 * @return The request parameter's value that has to be send to choose that sort option. 040 */ 041 String getParamValue(); 042 043 /** Returns the sort value as send to Solr. 044 * @return The sort value as send to Solr. 045 */ 046 String getSolrValue(); 047}