org.opencms.jsp.search.config.I_CmsSearchConfigurationFacetQuery Maven / Gradle / Ivy

Go to download
/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.jsp.search.config;

import java.util.List;

/** Interface for the query facet configuration. */
public interface I_CmsSearchConfigurationFacetQuery extends I_CmsSearchConfigurationFacet {

    /** The interface of a single query facet item. */
    public interface I_CmsFacetQueryItem {

        /** Returns the label of the item, useful to show it.
         * @return the label of the item.
         */
        String getLabel();

        /** Returns the query of the item.
         * @return the query of the item.
         */
        String getQuery();
    }

    /** The name of the range facet. */
    String NAME = "query_query";

    /** Returns the list of queries that belong to the facet.
     * @return The list of queries that belong to the facet.
     */
    List getQueryList();
}