Package org.gbif.api.model.common.paging

Interface Pageable

All Known Subinterfaces:
SearchRequest<P>
All Known Implementing Classes:
BaseSearchRequest, DatasetRequestSearchParams, DatasetSearchRequest, DatasetSuggestRequest, DescriptorGroupSearchRequest, DescriptorSearchRequest, EventPredicateSearchRequest, EventSearchRequest, FacetedSearchRequest, FacetedSearchResponse, InstallationRequestSearchParams, LiteratureSearchRequest, NameUsageSearchRequest, NameUsageSuggestRequest, NetworkRequestSearchParams, NodeRequestSearchParams, OccurrencePredicateSearchRequest, OccurrenceSearchRequest, OrganizationRequestSearchParams, PageableBase, PagingRequest, PagingResponse, RequestSearchParams, SearchResponse
public interface Pageable
Most simple paging interface for both request and responses.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static @interface 
    Pageable.OffsetLimitParameters
    The usual (search) limit and offset parameters

  • Method Summary

    Modifier and Type
    Method
    Description
    @jakarta.validation.constraints.Min(0L) int
    getLimit()
    Maximum number of records to be returned.
    @jakarta.validation.constraints.Min(0L) long
    getOffset()
    Defines how many items to skip before beginning to return records.

  • Method Details

    • getLimit

      @Min(0L) @jakarta.validation.constraints.Min(0L) int getLimit()
      Maximum number of records to be returned.
      Returns:
      the limit.

    • getOffset

      @Min(0L) @jakarta.validation.constraints.Min(0L) long getOffset()
      Defines how many items to skip before beginning to return records.
      Returns:
      the offset with 0 being no offset at all.