Package com.atlassian.confluence.api.model.pagination

Interface PaginationBatch<T>

All Superinterfaces:
Function<LimitedRequest,PageResponse<T>>
public interface PaginationBatch<T> extends 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

    Modifier and Type
    Method
    Description
    default boolean
    performsFiltering()
    Defines if the resulted batch may undergo additional filtering based on some conditions (f.e.

    Methods inherited from interface java.util.function.Function

    andThen, apply, compose

  • Method Details

    • performsFiltering

      default boolean performsFiltering()
      Defines if the resulted batch may undergo additional filtering based on some conditions (f.e. user permissions) This field is used for performance optimisation purposes.
      Returns:
      true if instance of this interface may perform additional filtering of the result set (default value), false otherwise