Show TOC

SuggestionFilter ObjectLocate this document in the navigation structure

Use

The SuggestionFilter object is used to define conditions by which to filter suggestions for a search term. This object provides the following methods to access its properties:

Method

Description

setNumSuggestions(val)

Defines the number of suggestions for each category

getNumSuggestions()

Returns the number of suggestions for each category

setSearchOption(val)

Defines which search option to use for the suggestions:

  • contains : to contain the search term

  • startsWith : to start with the search term

getSearchOption()

Returns the search option

setCategories(list)

Defines a semicolon-delimited list of categories; null means all categories

getCategories()

Returns the list of categories

setLogicalOperator(val)

Defines which logical operator, and or or , to apply to multiple words in the search term

getLogicalOperator()

Returns the logical operator to apply to multiple words in the search term

setAdditionalParams(params)

Defines a key-value list of additional parameters; empty list means no additional parameters

getAdditionalParams()

Returns the key-value list of additional parameters

Note

You can define the default values of all settings by configuring the SuggestionProviderRegistration service, contained in the com.sap.portal.suggestion.providers module, in SAP NetWeaver Administrator.