public interface ISearchQuery
Modifier and Type | Method and Description |
---|---|
void |
clear()
Reset the query state back to the original values
|
ISearchQuery |
cloneSearchQuery()
Makes a clone of this search query
|
Integer |
getInvocationID()
Return the unique id of the search invocation, the search
result portlet can use this id to determine if a new search has
been executed.
|
String |
getKeywordsField()
Deprecated.
use @link #getKeywordTerms() or @link #getNormalizedKeywordTerms() instead
|
String[] |
getKeywordTerms()
Gets the keywords field parsed into search terms.
|
Integer |
getMaxResults()
Get the maximum number of results allowed in the search results
|
String[] |
getNormalizedKeywordTerms()
Gets the keyword fields parsed into search terms and normalized.
|
Map<String,Object> |
getRefineFields()
Returns the map of refine field name/value pairs for the query
|
Boolean |
getUseOrCondition()
Return true to use an 'or' query or false for
an 'and' query.
|
void |
populateFromSearchStateString(String stateString)
Populate this object with data deserialized from the stateString.
|
void |
setInvocationID(Integer invokeID)
Setter for the invocation id
|
String |
toSearchStateString(ISearchStateOptions searchStateOptions)
Serialize the search state to a string
|
Integer getInvocationID()
void setInvocationID(Integer invokeID)
invokeID
- the invocation idInteger getMaxResults()
String getKeywordsField()
String[] getKeywordTerms()
String[] getNormalizedKeywordTerms()
Map<String,Object> getRefineFields()
Boolean getUseOrCondition()
void clear()
ISearchQuery cloneSearchQuery()
String toSearchStateString(ISearchStateOptions searchStateOptions)
searchStateOptions
- the options to use when writing the search statevoid populateFromSearchStateString(String stateString)
stateString
- the search state string (from toSearchStateString method)