Package org.opencms.jsp.search.state
Class CmsSearchStateCommon
- java.lang.Object
-
- org.opencms.jsp.search.state.CmsSearchStateCommon
-
- All Implemented Interfaces:
I_CmsSearchStateCommon
public class CmsSearchStateCommon extends java.lang.Object implements I_CmsSearchStateCommon
Class for handling the state of the common search options.
-
-
Constructor Summary
Constructors Constructor Description CmsSearchStateCommon()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.lang.String>
getAdditionalParameters()
Getter for the map from the additional request parameters to their values.boolean
getIsReloaded()
Getter for the flag indicating if the search is called the first time, or reloaded.java.lang.String
getLastQuery()
Returns the last query string (as entered by the user).java.lang.String
getQuery()
Returns the current query string (as entered by the user).void
setAdditionalParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
Setter for the additional parameters and their values.void
setIsReloaded(boolean isReloaded)
Setter for the flag indicating if the search is called the first time, or reloaded.void
setLastQuery(java.lang.String lastquery)
Setter for the last query string (as entered by the user).void
setQuery(java.lang.String query)
Setter for the current query string (as entered by the user).
-
-
-
Constructor Detail
-
CmsSearchStateCommon
public CmsSearchStateCommon()
-
-
Method Detail
-
getAdditionalParameters
public java.util.Map<java.lang.String,java.lang.String> getAdditionalParameters()
Description copied from interface:I_CmsSearchStateCommon
Getter for the map from the additional request parameters to their values.- Specified by:
getAdditionalParameters
in interfaceI_CmsSearchStateCommon
- Returns:
- The map from the additional request parameters to their values.
- See Also:
I_CmsSearchStateCommon.getAdditionalParameters()
-
getIsReloaded
public boolean getIsReloaded()
Description copied from interface:I_CmsSearchStateCommon
Getter for the flag indicating if the search is called the first time, or reloaded.- Specified by:
getIsReloaded
in interfaceI_CmsSearchStateCommon
- Returns:
- Typically, false only if the search form is loaded the first time, otherwise it should be true.
- See Also:
I_CmsSearchStateCommon.getIsReloaded()
-
getLastQuery
public java.lang.String getLastQuery()
Description copied from interface:I_CmsSearchStateCommon
Returns the last query string (as entered by the user).- Specified by:
getLastQuery
in interfaceI_CmsSearchStateCommon
- Returns:
- The last query string (as entered by the user).
- See Also:
I_CmsSearchStateCommon.getLastQuery()
-
getQuery
public java.lang.String getQuery()
Description copied from interface:I_CmsSearchStateCommon
Returns the current query string (as entered by the user).- Specified by:
getQuery
in interfaceI_CmsSearchStateCommon
- Returns:
- The current query string (as entered by the user).
- See Also:
I_CmsSearchStateCommon.getQuery()
-
setAdditionalParameters
public void setAdditionalParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
Description copied from interface:I_CmsSearchStateCommon
Setter for the additional parameters and their values.- Specified by:
setAdditionalParameters
in interfaceI_CmsSearchStateCommon
- Parameters:
parameters
- Map from the additional parameters and their values.- See Also:
I_CmsSearchStateCommon.setAdditionalParameters(java.util.Map)
-
setIsReloaded
public void setIsReloaded(boolean isReloaded)
Description copied from interface:I_CmsSearchStateCommon
Setter for the flag indicating if the search is called the first time, or reloaded.- Specified by:
setIsReloaded
in interfaceI_CmsSearchStateCommon
- Parameters:
isReloaded
- Typically false only if the search form is loaded the first time, otherwise it should be true.- See Also:
I_CmsSearchStateCommon.setIsReloaded(boolean)
-
setLastQuery
public void setLastQuery(java.lang.String lastquery)
Description copied from interface:I_CmsSearchStateCommon
Setter for the last query string (as entered by the user).- Specified by:
setLastQuery
in interfaceI_CmsSearchStateCommon
- Parameters:
lastquery
- The last query string (as entered by the user).- See Also:
I_CmsSearchStateCommon.setLastQuery(java.lang.String)
-
setQuery
public void setQuery(java.lang.String query)
Description copied from interface:I_CmsSearchStateCommon
Setter for the current query string (as entered by the user).- Specified by:
setQuery
in interfaceI_CmsSearchStateCommon
- Parameters:
query
- The current query string (as entered by the user).- See Also:
I_CmsSearchStateCommon.setQuery(java.lang.String)
-
-