Skip to content

QRY_Builder.QueryPage

Class

apex
global class QRY_Builder.QueryPage

Result container for paged queries, providing records and pagination metadata.

Since: 1.0


Properties

PropertyDescription
global Boolean hasMorePagesTrue if there are more pages after the current page.
global Boolean hasPriorPagesTrue if there are pages before the current page.
global Integer totalPagesTotal number of pages available.

Fields

FieldDescription
global Database.PaginationCursor cursorThe PaginationCursor state for LWC round-trips.
global Integer deletedRecordsNumber of records deleted since the cursor was created.
global Integer pageNumberThe current page number (1-based).
global Integer pageSizeNumber of records per page.
global List recordsThe records for the requested page.
global Integer totalRecordsTotal number of records matching the query criteria.

Property Details

hasMorePages

apex
global Boolean hasMorePages

Type: Boolean

True if there are more pages after the current page.

Since:

Example:

hasPriorPages

apex
global Boolean hasPriorPages

Type: Boolean

True if there are pages before the current page.

Since:

Example:

totalPages

apex
global Integer totalPages

Type: Integer

Total number of pages available.

Since:

Example:


Field Details

cursor

apex
global Database.PaginationCursor cursor

Type: Database.PaginationCursor

The PaginationCursor state for LWC round-trips. Can be passed back to the server for stable pagination across requests.

Since: 1.0

Example:

apex
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
    .getPage(1, 25);
Database.PaginationCursor cursor = page.cursor;

deletedRecords

apex
global Integer deletedRecords

Type: Integer

Number of records deleted since the cursor was created. Useful for detecting data changes between page fetches.

Since: 1.0

Example:

apex
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
    .getPage(1, 25);
Integer deleted = page.deletedRecords;

pageNumber

apex
global Integer pageNumber

Type: Integer

The current page number (1-based).

Since: 1.0

Example:

apex
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
    .getPage(2, 25);
Integer currentPage = page.pageNumber; // 2

pageSize

apex
global Integer pageSize

Type: Integer

Number of records per page.

Since: 1.0

Example:

apex
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
    .getPage(1, 25);
Integer size = page.pageSize; // 25

records

apex
global List<SObject> records

Type: List

The records for the requested page.

Since: 1.0

Example:

apex
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
    .getPage(1, 25);
List<SObject> pageRecords = page.records;

totalRecords

apex
global Integer totalRecords

Type: Integer

Total number of records matching the query criteria.

Since: 1.0

Example:

apex
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
    .getPage(1, 25);
Integer total = page.totalRecords;