Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Batchable Interface
BatchableContext Interface
Cursor Class
CursorFetchResult Class
CursorFetchResult Methods
DeletedRecord Class
DeleteResult Class
DMLOptions Class
DmlOptions.AssignmentRuleHeader Class
DMLOptions.DuplicateRuleHeader Class
DmlOptions.EmailHeader Class
DuplicateError Class
EmptyRecycleBinResult Class
Error Class
GetDeletedResult Class
GetUpdatedResult Class
LeadConvert Class
LeadConvertResult Class
MergeResult Class
PaginationCursor Class
QueryLocator Class
QueryLocatorIterator Class
SaveResult Class
UndeleteResult Class
UpsertResult Class
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

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.

Namespace

Database

CursorFetchResult Methods

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.

Signature

public Integer getNextIndex()

Return Value

Type: Integer

getNumDeletedRecords()

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

Signature

public Integer getNumDeletedRecords()

Return Value

Type: Integer

getRecords()

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

Signature

public List<SObject> getRecords()

Return Value

Type: List<sObject>

The list of sObjects from the SOQL query for 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.

Signature

public Boolean isDone()

Return Value

Type: Boolean