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/** Interface for the query facet configuration. */
033public interface I_CmsSearchConfigurationFacetQuery extends I_CmsSearchConfigurationFacet {
034
035    /** The interface of a single query facet item. */
036    public interface I_CmsFacetQueryItem {
037
038        /** Returns the label of the item, useful to show it.
039         * @return the label of the item.
040         */
041        String getLabel();
042
043        /** Returns the query of the item.
044         * @return the query of the item.
045         */
046        String getQuery();
047    }
048
049    /** The name of the range facet. */
050    String NAME = "query_query";
051
052    /** Returns the list of queries that belong to the facet.
053     * @return The list of queries that belong to the facet.
054     */
055    List<I_CmsFacetQueryItem> getQueryList();
056}