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
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
AsyncDeleteCallback Class
AsyncSaveCallback Class
AuthenticationCapability Enum
AuthenticationProtocol Enum
Capability Enum
Column Class
ColumnSelection Class
Connection Class
ConnectionParams Class
DataSourceUtil Class
DataType Enum
DeleteContext Class
DeleteResult Class
Filter Class
FilterType Enum
IdentityType Enum
Order Class
OrderDirection Enum
Provider Class
QueryAggregation Enum
QueryContext Class
QueryUtils Class
ReadContext Class
SearchContext Class
SearchUtils Class
Table Class
TableResult Class
TableResult Properties
TableResult Methods
TableSelection Class
UpsertContext Class
UpsertResult Class
DataSource Exceptions
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

TableResult Class

Contains the results of a search or query.

Namespace

DataSource

TableResult Properties

The following are properties for TableResult.

errorMessage

errorMessage

Signature

public String errorMessage {get; set;}

Property Value

Type: String

queryMoreToken

Query token that’s used for server-driven paging to determine and fetch the subsequent batch of results. This token is passed back to the Apex data source on subsequent queries in the queryMoreToken property on the QueryContext.​

Signature

public String queryMoreToken {get; set;}

Property Value

Type: String

rows

Rows of data.

Signature

public List<Map<String,Object>> rows {get; set;}

Property Value

Type: List<Map<String, Object>>

success

Whether the search or query was successful.

Signature

public Boolean success {get; set;}

Property Value

Type: Boolean

tableName

Name of the table that was queried.

Signature

public String tableName {get; set;}

Property Value

Type: String

totalSize

The total number of rows that meet the query criteria, even when the external system is requested to return a smaller batch size.

Signature

public Integer totalSize {get; set;}

Property Value

Type: Integer

TableResult Methods

The following are methods for TableResult.

error(errorMessage)

Returns failed search or query results with the provided error message.

Signature

public static DataSource.TableResult error(String errorMessage)

Parameters

errorMessage
Type: String
errorMessage

Return Value

Type: DataSource.TableResult

The returned TableResult has these property values.
Property Value
success false
errorMessage errorMessage
tableName null
rows null
rows.size() 0

get(success, errorMessage, tableName, rows, totalSize)

Returns a subset of data rows in a TableResult with the provided property values and the number of rows in the table.

Signature

public static DataSource.TableResult get(Boolean success, String errorMessage, String tableName, List<Map<String,Object>> rows, Integer totalSize)

Parameters

success
Type: Boolean
Whether the search or query was successful.
errorMessage
Type: String
errorMessage
tableName
Type: String
Name of the table that was queried.
rows
Type: List<Map<String, Object>>
Rows of data.
totalSize
Type: Integer
The total number of rows that meet the query criteria, even when the external system is requested to return a smaller batch size.

Return Value

Type: DataSource.TableResult

get(success, errorMessage, tableName, rows)

Returns a subset of data rows in a TableResult with the provided property values.

Signature

public static DataSource.TableResult get(Boolean success, String errorMessage, String tableName, List<Map<String,Object>> rows)

Parameters

success
Type: Boolean
Whether the search or query was successful.
errorMessage
Type: String
errorMessage
tableName
Type: String
Name of the table that was queried.
rows
Type: List<Map<String, Object>>
Rows of data.

Return Value

Type: DataSource.TableResult

get(queryContext, rows)

Returns the subset of data rows that meet the query criteria, and the number of rows in the table, in a TableResult.

Signature

public static DataSource.TableResult get(DataSource.QueryContext queryContext, List<Map<String,Object>> rows)

Parameters

queryContext
Type: DataSource.QueryContext
Represents the query to run against a data table.
rows
Type: List<Map<String, Object>>
Rows of data.

Return Value

Type: DataSource.TableResult

get(tableSelection, rows)

Returns the subset of data rows that meet the query criteria, and the number of rows in the table, in a TableResult.

Signature

public static DataSource.TableResult get(DataSource.TableSelection tableSelection, List<Map<String,Object>> rows)

Parameters

tableSelection
Type: DataSource.TableSelection
Query details that represent the FROM, ORDER BY, SELECT, and WHERE clauses in a SOQL or SOSL query.
rows
Type: List<Map<String, Object>>
Rows of data.

Return Value

Type: DataSource.TableResult