org.gbif.api.model.common.paging

Interface Pageable

All Known Implementing Classes:

DatasetRequestSearchParams, DatasetSearchRequest, DatasetSuggestRequest, DescriptorGroupSearchRequest, DescriptorSearchRequest, FacetedSearchRequest, FacetedSearchResponse, InstallationRequestSearchParams, LiteratureSearchRequest, NameUsageSearchRequest, NameUsageSuggestRequest, NetworkRequestSearchParams, NodeRequestSearchParams, OccurrencePredicateSearchRequest, OccurrenceSearchRequest, OrganizationRequestSearchParams, PageableBase, PagingRequest, PagingResponse, RequestSearchParams, SearchRequest, SearchResponse

public interface Pageable

Most simple paging interface for both request and responses.

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getLimit

@Min(value=0L)
@Min(value=0L) int getLimit()

Maximum number of records to be returned.

Returns:

the limit.

getOffset

@Min(value=0L)
@Min(value=0L) long getOffset()

Defines how many items to skip before beginning to return records.

Returns:

the offset with 0 being no offset at all.