Package org.apache.syncope.common.lib.to
Class PagedConnObjectResult
java.lang.Object
org.apache.syncope.common.lib.to.PagedConnObjectResult
- All Implemented Interfaces:
Serializable,BaseBean
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleangetNext()Returns the opaque cookie which should be used with the next paged results search request.intReturns an estimate of the total number of remaining results to be returned in subsequent paged results search requests.inthashCode()booleanReturns a flag indicating whether all the results other match a search query were returned.voidsetAllResultsReturned(boolean allResultsReturned) voidvoidsetPagedResultsCookie(String pagedResultsCookie) voidsetRemainingPagedResults(int remainingPagedResults)
-
Constructor Details
-
PagedConnObjectResult
public PagedConnObjectResult()
-
-
Method Details
-
getNext
-
setNext
-
getPagedResultsCookie
Returns the opaque cookie which should be used with the next paged results search request.- Returns:
- The opaque cookie which should be used with the next paged results search request, or
nullif paged results were not requested, or if there are not more pages to be returned.
-
setPagedResultsCookie
- Parameters:
pagedResultsCookie- The opaque cookie which should be used with the next paged results search request, ornullif paged results were not requested, or if there are not more pages to be returned.
-
getRemainingPagedResults
public int getRemainingPagedResults()Returns an estimate of the total number of remaining results to be returned in subsequent paged results search requests.- Returns:
- An estimate of the total number of remaining results to be returned in subsequent paged results search
requests, or
-1if paged results were not requested, or if the total number of remaining results is unknown.
-
setRemainingPagedResults
public void setRemainingPagedResults(int remainingPagedResults) - Parameters:
remainingPagedResults- An estimate of the total number of remaining results to be returned in subsequent paged results search requests, or-1if paged results were not requested, or if the total number of remaining results is unknown.
-
isAllResultsReturned
public boolean isAllResultsReturned()Returns a flag indicating whether all the results other match a search query were returned.- Returns:
- true if the search returned all the results other match the query, 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.
-
setAllResultsReturned
public void setAllResultsReturned(boolean allResultsReturned) - Parameters:
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.
-
getResult
-
hashCode
public int hashCode() -
equals
-