Interface PaginationMetadata
public interface PaginationMetadata
Describes how a resource should be paginated
- Author:
- cdivilly
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final PaginationMetadataConstant indicating a resource is not paginated -
Method Summary
-
Field Details
-
NOT_PAGINATED
Constant indicating a resource is not paginated
-
-
Method Details
-
limit
long limit()Indicates the maximum number of items per page for this resource. Note that this value may be overridden by thePaginationContext.limit()up to the ceiling imposed by thePagination.maximumLimit()value.- Returns:
- The maximum number of items
-
type
PaginationStrategy type()The type of pagination strategy that this resource should use. Note that all paginated resources can be paginated with any of the supportedPaginationStrategys, this property indicates the default pagination strategy that should be used for the resource.- Returns:
PaginationStrategyinstance
-