CursorFetchResult Class

This class encapsulates the result of a PaginationCursor.fetchPage() call. It contains methods that get the rows for the current page, the start index of the next page, and the number of deleted rows skipped during the fetch operation. It also contains a method that indicates whether the pagination cursor has fetched all available rows in the result set.

Database

The following are methods for CursorFetchResult.

  • getNextIndex()

    Gets the start index required to fetch the next page of results. Use this value as the start parameter in the call to PaginationCursor.fetchPage(start, pageSize) to fetch the next page of results.

  • getNumDeletedRecords()

    Gets the number of deleted rows that were skipped during the fetch operation.

  • getRecords()

    Gets the list of records that comprise the rows on the current page.

  • isDone()

    Returns true if the pagination cursor has reached either the page size passed to PaginationCursor.fetchPage(start, pageSize) or the end of the result set. Otherwise returns false.

Gets the start index required to fetch the next page of results. Use this value as the start parameter in the call to PaginationCursor.fetchPage(start, pageSize) to fetch the next page of results.

public Integer getNextIndex()

Type: Integer

Gets the number of deleted rows that were skipped during the fetch operation.

public Integer getNumDeletedRecords()

Type: Integer

Gets the list of records that comprise the rows on the current page.

public List<SObject> getRecords()

Type: List<sObject>

The list of sObjects from the SOQL query for the current page.

Returns true if the pagination cursor has reached either the page size passed to PaginationCursor.fetchPage(start, pageSize) or the end of the result set. Otherwise returns false.

public Boolean isDone()

Type: Boolean

See Also