com.atlassian.confluence.api.model.pagination

Interface PaginationBatch<T>

All Superinterfaces:

com.google.common.base.Function<LimitedRequest,PageResponse<T>>

@ExperimentalApi
public interface PaginationBatch<T>
extends com.google.common.base.Function<LimitedRequest,PageResponse<T>>

A pagination batch is responsible for supplying a pageResponse for a given pageRequest.

A pagination template should treat the pageRequest values as sql OFFSET and LIMIT, but only return the results in the request that a user has permission to view. If a user does not have permission to view any results, return an empty PageResponse with the has more flag set

Implementations should honour the limit property and not pull significantly more results from the database than the limit property allows.

Implementations may honour the needed property of the LimitedRequest to provide a partial result set from the fetched limited items.

Method Summary

Methods inherited from interface com.google.common.base.Function

apply, equals