jakarta.nosql.mapping.document

Interface DocumentQueryPagination

All Superinterfaces:

DocumentQuery

public interface DocumentQueryPagination
extends DocumentQuery

A DocumentQuery that allows select based on pagination.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DocumentQueryPagination.DocumentQueryPaginationProvider A provider DocumentQueryPagination of where given two parameters: The first is DocumentQuery The second is Pagination it returns an instance DocumentQueryPagination

Nested classes/interfaces inherited from interface jakarta.nosql.document.DocumentQuery

DocumentQuery.DocumentFrom, DocumentQuery.DocumentLimit, DocumentQuery.DocumentNameCondition, DocumentQuery.DocumentNameOrder, DocumentQuery.DocumentNotCondition, DocumentQuery.DocumentOrder, DocumentQuery.DocumentQueryBuild, DocumentQuery.DocumentQueryBuilder, DocumentQuery.DocumentQueryBuilderProvider, DocumentQuery.DocumentSelect, DocumentQuery.DocumentSelectProvider, DocumentQuery.DocumentSkip, DocumentQuery.DocumentWhere

Method Summary

Modifier and Type	Method and Description
Pagination	getPagination() Returns the Pagination of the current Page
DocumentQueryPagination	next() Returns the DocumentQueryPagination requesting the next DocumentQueryPagination.
static DocumentQueryPagination	of(DocumentQuery query, Pagination pagination) Creates a new instance of DocumentQueryPagination

Methods inherited from interface jakarta.nosql.document.DocumentQuery

builder, builder, getCondition, getDocumentCollection, getDocuments, getLimit, getSkip, getSorts, select, select

Method Detail

next

DocumentQueryPagination next()

Returns the DocumentQueryPagination requesting the next DocumentQueryPagination.

Returns:

the next DocumentQueryPagination

getPagination

Pagination getPagination()

Returns the Pagination of the current Page

Returns:

a current Pagination

of

static DocumentQueryPagination of(DocumentQuery query,
                                  Pagination pagination)

Creates a new instance of DocumentQueryPagination

Parameters:

query - the query

pagination - the pagination

Returns:

a DocumentQueryPagination instance

Throws:

NullPointerException - when there is null parameter