public class PagedConnObjectTOResult extends Object implements Serializable
Constructor and Description |
---|
PagedConnObjectTOResult() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
URI |
getNext() |
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.
|
List<ConnObjectTO> |
getResult() |
int |
hashCode() |
boolean |
isAllResultsReturned()
Returns a flag indicating whether all the results other match a search query were returned.
|
void |
setAllResultsReturned(boolean allResultsReturned) |
void |
setNext(URI next) |
void |
setPagedResultsCookie(String pagedResultsCookie) |
void |
setRemainingPagedResults(int remainingPagedResults) |
public URI getNext()
public void setNext(URI next)
public String getPagedResultsCookie()
null
if
paged results were not requested, or if there are not more pages to be returned.public void setPagedResultsCookie(String pagedResultsCookie)
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.public int getRemainingPagedResults()
-1
if paged results were not requested, or if the total number of remaining results is
unknown.public void setRemainingPagedResults(int remainingPagedResults)
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 boolean isAllResultsReturned()
public void setAllResultsReturned(boolean allResultsReturned)
allResultsReturned
- Set to true if the search returned all the results other 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 List<ConnObjectTO> getResult()
Copyright © 2010–2023 The Apache Software Foundation. All rights reserved.