Package com.dnanexus
Interface DXSearch.FindResultPage<T>
-
- Type Parameters:
T- Type of result to be returned e.g. DXDataObject for findDataObjects
- All Superinterfaces:
Iterable<T>
- Enclosing class:
- DXSearch
public static interface DXSearch.FindResultPage<T> extends Iterable<T>
Represents a single page of results for a find route.A page contains a set of matching results that can be retrieved using the Iterator protocol, as well as a "bookmark" that can be used to retrieve the next page.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description com.fasterxml.jackson.databind.JsonNodegetNext()Returns an object that can be used in a later call to getSubsequentPage (e.g.booleanhasNextPage()Returns true if more results exist.intsize()Returns the number of results in the current page.-
Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator
-
-
-
-
Method Detail
-
getNext
com.fasterxml.jackson.databind.JsonNode getNext()
Returns an object that can be used in a later call to getSubsequentPage (e.g.DXSearch.FindDataObjectsResult.getSubsequentPage(JsonNode, int)) to continue retrieving results where this page leaves off, or null if there are no more results after the end of this page.
-
hasNextPage
boolean hasNextPage()
Returns true if more results exist.- Returns:
- whether there are more results
-
size
int size()
Returns the number of results in the current page.- Returns:
- size of the current page
-
-