org.opencms.jsp.search.state.I_CmsSearchStateCommon Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation
Show all versions of opencms-test Show documentation
OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (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.state;
import java.util.Map;
/** Class for keeping the state of the common search options. */
public interface I_CmsSearchStateCommon {
/** Getter for the map from the additional request parameters to their values.
* @return The map from the additional request parameters to their values.
*/
Map getAdditionalParameters();
/** Getter for the flag indicating if the search is called the first time, or reloaded.
* @return Typically, false only if the search form is loaded the first time, otherwise it should be true.
*/
boolean getIsReloaded();
/** Returns the last query string (as entered by the user).
* @return The last query string (as entered by the user).
*/
String getLastQuery();
/** Returns the current query string (as entered by the user).
* @return The current query string (as entered by the user).
*/
String getQuery();
/** Setter for the additional parameters and their values.
* @param parameters Map from the additional parameters and their values.
*/
void setAdditionalParameters(Map parameters);
/** Setter for the flag indicating if the search is called the first time, or reloaded.
* @param isReloaded Typically false only if the search form is loaded the first time, otherwise it should be true.
*/
void setIsReloaded(boolean isReloaded);
/** Setter for the last query string (as entered by the user).
* @param lastquery The last query string (as entered by the user).
*/
void setLastQuery(String lastquery);
/** Setter for the current query string (as entered by the user).
* @param query The current query string (as entered by the user).
*/
void setQuery(String query);
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy