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.state;
029
030import java.util.Map;
031
032/** Class for keeping the state of the common search options. */
033public interface I_CmsSearchStateCommon {
034
035    /** Getter for the map from the additional request parameters to their values.
036     * @return The map from the additional request parameters to their values.
037     */
038    Map<String, String> getAdditionalParameters();
039
040    /** Getter for the flag indicating if the search is called the first time, or reloaded.
041     * @return Typically, false only if the search form is loaded the first time, otherwise it should be true.
042     */
043    boolean getIsReloaded();
044
045    /** Returns the last query string (as entered by the user).
046     * @return The last query string (as entered by the user).
047     */
048    String getLastQuery();
049
050    /** Returns the current query string (as entered by the user).
051     * @return The current query string (as entered by the user).
052     */
053    String getQuery();
054
055    /** Setter for the additional parameters and their values.
056     * @param parameters Map from the additional parameters and their values.
057     */
058    void setAdditionalParameters(Map<String, String> parameters);
059
060    /** Setter for the flag indicating if the search is called the first time, or reloaded.
061     * @param isReloaded Typically false only if the search form is loaded the first time, otherwise it should be true.
062     */
063    void setIsReloaded(boolean isReloaded);
064
065    /** Setter for the last query string (as entered by the user).
066     * @param lastquery The last query string (as entered by the user).
067     */
068    void setLastQuery(String lastquery);
069
070    /** Setter for the current query string (as entered by the user).
071     * @param query The current query string (as entered by the user).
072     */
073    void setQuery(String query);
074}