com.atlassian.confluence.api.model.pagination
Interface LimitedRequest

All Known Implementing Classes:

LimitedRequestImpl

@ExperimentalApi
public interface LimitedRequest

A PageRequest guaranteed to have a limit capped to a developer provided value rather than a user provided value. getLimit is restricted to the minimum of getMaxLimit and the user provided value.

Method Summary

int	getLimit()
int	getMaxLimit()
int	getNeeded()
int	getStart() start index for the page of results

Method Detail

getStart

int getStart()

start index for the page of results

getLimit

int getLimit()

Returns:

the maximum results to fetch to attempt to fulfil the request

getMaxLimit

int getMaxLimit()

Returns:

the maximum limit for this request

getNeeded

int getNeeded()

Returns:

the number of results needed to return to fulfill this request, may exceed getLimit