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.result;
029
030import java.util.Map;
031
032/** Interface for the search state parameters. */
033public interface I_CmsSearchStateParameters {
034
035    /** Returns the search state parameters with the parameter for ignoring a facet's (specified by first key) limit added.
036     * @return The search state parameters with the parameter for ignoring a facet's (specified by first key) limit added.
037     */
038    Map<String, I_CmsSearchStateParameters> getAddIgnoreFacetLimit();
039
040    /** Returns the search state parameters with the filter query for facets (specified by first key) item (specified by the second key) added.
041     * @return The search state parameters with the filter query for facets (specified by first key) item (specified by the second key) added.
042     */
043    Map<String, Map<String, I_CmsSearchStateParameters>> getCheckFacetItem();
044
045    /** Returns the search state parameters with the Query parameter's value adjusted to the key of the map.
046     * @return The search state parameters with the Query parameter's value adjusted to the key of the map.
047     */
048    Map<String, I_CmsSearchStateParameters> getNewQuery();
049
050    /** Returns the search state parameters with the parameter for ignoring a facet's (specified by first key) limit removed.
051     * @return The search state parameters with the parameter for ignoring a facet's (specified by first key) limit removed.
052     */
053    Map<String, I_CmsSearchStateParameters> getRemoveIgnoreFacetLimit();
054
055    /** Returns the search state parameters with all filter queries for facets removed.
056     * @return The search state parameters with all filter queries for facets removed.
057     */
058    I_CmsSearchStateParameters getResetAllFacetStates();
059
060    /** Returns the search state parameters with all filter queries for the facet specified as key removed.
061     * @return The search state parameters with all filter queries for the facet specified as key removed.
062     */
063    Map<String, I_CmsSearchStateParameters> getResetFacetState();
064
065    /** Returns the search state parameters with the additional parameter (specified by first key) set to the value (specified by the second key).
066     * @return The search state parameters with the additional parameter (specified by first key) set to the value (specified by the second key).
067     */
068    Map<String, Map<String, I_CmsSearchStateParameters>> getSetAdditionalParam();
069
070    /** Returns the search state parameters with the value for the current page's parameter replaced by the key.
071     * @return The search state parameters with the value for the current page's parameter replaced by the key.
072     */
073    Map<String, I_CmsSearchStateParameters> getSetPage();
074
075    /** Returns the search state parameters with the value for the sort parameter replaced by the key.
076     * @return The search state parameters with the value for the sort parameter replaced by the key.
077     */
078    Map<String, I_CmsSearchStateParameters> getSetSortOption();
079
080    /** Returns the search state parameters with the filter query for facets (specified by first key) item (specified by the second key) removed.
081     * @return The search state parameters with the filter query for facets (specified by first key) item (specified by the second key) removed.
082     */
083    Map<String, Map<String, I_CmsSearchStateParameters>> getUncheckFacetItem();
084
085    /** Returns the search state parameters with the additional parameter (specified by the key) removed.
086     * @return The search state parameters with the additional parameter (specified by the key) removed.
087     */
088    Map<String, I_CmsSearchStateParameters> getUnsetAdditionalParam();
089
090}