public final class SearchResult extends Object implements Serializable
Constructor and Description |
---|
SearchResult()
Creates a new search result with a
null paged results cookie and no estimate of the total number of
remaining results. |
SearchResult(String pagedResultsCookie,
int remainingPagedResults)
Creates a new search result with the provided paged results cookie and estimate of the total number of remaining
results.
|
SearchResult(String pagedResultsCookie,
int remainingPagedResults,
boolean allResultsReturned)
Creates a new search result with the provided paged results cookie and estimate of the total number of remaining
results.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getPagedResultsCookie()
Returns the opaque cookie which should be used with the next paged results search request.
|
int |
getRemainingPagedResults()
Returns an estimate of the total number of remaining results to be returned in subsequent paged results search
requests.
|
int |
hashCode() |
boolean |
isAllResultsReturned()
Returns a flag indicating whether all the results that match a search query were returned.
|
String |
toString() |
public SearchResult()
null
paged results cookie and no estimate of the total number of
remaining results.public SearchResult(String pagedResultsCookie, int remainingPagedResults)
pagedResultsCookie
- The opaque cookie which should be used with the next paged results search request, or
null
if paged results were not requested, or if there are not more pages to be returned.remainingPagedResults
- An estimate of the total number of remaining results to be returned in subsequent
paged results search requests, or -1
if paged results were not requested, or if the total number of
remaining results is unknown.public SearchResult(String pagedResultsCookie, int remainingPagedResults, boolean allResultsReturned)
pagedResultsCookie
- The opaque cookie which should be used with the next paged results search request, or
null
if paged results were not requested, or if there are not more pages to be returned.remainingPagedResults
- An estimate of the total number of remaining results to be returned in subsequent
paged results search requests, or -1
if paged results were not requested, or if the total number of
remaining results is unknown.allResultsReturned
- Set to true if the search returned all the results that match the query. Set to false
if the returned result is not complete, e.g. if the server returned only part of the results due to server
limits, errors, etc.public String getPagedResultsCookie()
null
if
paged results were not requested, or if there are not more pages to be returned.public int getRemainingPagedResults()
-1
if paged results were not requested, or if the total number of remaining results is
unknown.public boolean isAllResultsReturned()
Copyright © 2019. All rights reserved.