ISearchOptionsManager (server-common-api)

All Known Implementing Classes:

InMemorySearchOptionsManager, PortletPrefsSearchOptionsManager, SimpleWebAppSearchOptionsManager
```
public interface ISearchOptionsManager
```
Implementations of this interface handle the lookup and updating of search options

Since:

7.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_INITIAL_SEARCH_TAB` This search option controls which searchbar tab to activate when the page is initially displayed.
`static String`	`KEY_INITIAL_SELECTED_SAVED_SEARCH` This search option controls which saved search to load when the page is initially displayed.
`static String`	`KEY_LAST_SEARCH_STATE` This search option holds the serialized state of the last search query that was run.
`static String`	`KEY_MAX_RESULTS` This search option specifies the maximum number of rows to display in the search results table.
`static String`	`KEY_NO_MAX_RESULTS` This search option controls whether the search results should enforce a maxiumum number of results.
`static String`	`KEY_RUN_SEARCH_ON_DISPLAY` This search option controls whether a search is automatically triggered when the page is initially displayed.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Map<String,Object>`	`getSearchOptions()` Get a map of the current search options
`void`	`updateSearchOptions(Map<String,Object> optionsMap)` Update the search options

- Field Detail
  - KEY_INITIAL_SEARCH_TAB
```
static final String KEY_INITIAL_SEARCH_TAB
```
    This search option controls which searchbar tab to activate when the page is initially displayed. The value must be one of the following strings:
    - simpleSearch
    - simpleSearch/refined
    - advancedSearch
    - savedSearches
    - savedSearches/details
    See Also:
    
    Constant Field Values
  - KEY_RUN_SEARCH_ON_DISPLAY
```
static final String KEY_RUN_SEARCH_ON_DISPLAY
```
    This search option controls whether a search is automatically triggered when the page is initially displayed. The value must be either true or false.
    
    See Also:
    
    Constant Field Values
  - KEY_INITIAL_SELECTED_SAVED_SEARCH
```
static final String KEY_INITIAL_SELECTED_SAVED_SEARCH
```
    This search option controls which saved search to load when the page is initially displayed. The value should be the name of a saved search or null if no saved search should be loaded.
    
    See Also:
    
    Constant Field Values
  - KEY_NO_MAX_RESULTS
```
static final String KEY_NO_MAX_RESULTS
```
    This search option controls whether the search results should enforce a maxiumum number of results. The value must be either true or false.
    
    See Also:
    
    Constant Field Values
  - KEY_MAX_RESULTS
```
static final String KEY_MAX_RESULTS
```
    This search option specifies the maximum number of rows to display in the search results table. The value must be a positive number.
    
    See Also:
    
    Constant Field Values
  - KEY_LAST_SEARCH_STATE
```
static final String KEY_LAST_SEARCH_STATE
```
    This search option holds the serialized state of the last search query that was run. Custom implementations would not typically manually change this value.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getSearchOptions
```
Map<String,Object> getSearchOptions()
```
    Get a map of the current search options
    
    Returns:
    
    map of search options
  - updateSearchOptions
```
void updateSearchOptions(Map<String,Object> optionsMap)
```
    Update the search options
    
    Parameters:
    
    optionsMap - the options to update
    
    persist - true to attempt to persist the changes to the long term storage

Interface ISearchOptionsManager

Field Summary

Method Summary

Field Detail

KEY_INITIAL_SEARCH_TAB

KEY_RUN_SEARCH_ON_DISPLAY

KEY_INITIAL_SELECTED_SAVED_SEARCH

KEY_NO_MAX_RESULTS

KEY_MAX_RESULTS

KEY_LAST_SEARCH_STATE

Method Detail

getSearchOptions

updateSearchOptions