public interface SearchService
Modifier and Type | Method and Description |
---|---|
void |
clearSearchResultsInfo(SearchToken token)
Releases the token and any cached information about the query associated with the token.
|
int |
getPageSizeLimit()
Gets the maximum number of search entries that can be returned in a single request.
|
List<SearchResultObject> |
getSearchResults(SearchToken token,
int fromRow,
int toRow)
Gets SearchResult objects using a token from SearchResultsInfo which is obtained by calling
getSearchResultsInfoByQuery.
|
SearchResultsInfo |
getSearchResultsInfoByQuery(SearchQuery query)
Returns a SearchResultsInfo object which contains a token and row count in which to request search entries.
|
SearchResultsInfo getSearchResultsInfoByQuery(SearchQuery query) throws SearchException
query
- SearchQuery containing criteria in which to search the repository.SearchException
- thrown if there was error processing the query on the serverList<SearchResultObject> getSearchResults(SearchToken token, int fromRow, int toRow) throws SearchException
token
- A token identifying a generated search query on the serverfromRow
- Row number in which to start with. Must be greater than 0.toRow
- Row number to end with. Must be less than or equal to the rowCount on SearchResultsInfoSearchException
- thrown if the token has been cleared from the server or if the total row number
requested exceeds the page size limitvoid clearSearchResultsInfo(SearchToken token)
token
- A token identifying a generated search query on the serverint getPageSizeLimit()
Copyright (c) 2017, SAS Institute Inc., Cary, NC, USA