Namespace: search

.services.xs. search

Version:
  • 2.0.0

Methods

(static) autocomplete(suggestionRequest) → {sap.hana.im.ess.services.xs.messages.response.SuggestionResponse}

Returns autocompletion suggestions for keywords entered in the search query string. Suggestions match only indexed metadata, and are filtered with HANA security.

Parameters:
Name Type Description
suggestionRequest sap.hana.im.ess.services.xs.messages.request.SuggestionRequest
Returns:

keyword suggestions

Type
sap.hana.im.ess.services.xs.messages.response.SuggestionResponse

(static) prepare() → {undefined}

This method performs once per session preparation for an XS session. This offers an opportunity to perform costly operations in the background to improve application responsiveness. In the current implementation, it computes user credential mask that may take several seconds.

The call to this method is optional. If this method is not called prior to suggestion or search, the calculation of the user credential mask is triggered by the first call to suggestion or search.

Returns:
Type
undefined

(static) search(searchRequest) → {sap.hana.im.ess.services.xs.messages.response.SearchResponse}

Search in EntityGrid based on the search query string passed within the searchRequest parameter Results are filtered based by applying HANA security rules, based on the XS logged-on user

Parameters:
Name Type Description
searchRequest sap.hana.im.ess.services.xs.messages.request.SearchRequest
Throws:

SyntaxError (error in search query string)

Returns:

the search results

Type
sap.hana.im.ess.services.xs.messages.response.SearchResponse