Force.com Apex Code Developer's Guide

Getting Started
Writing Apex
Ways to Invoke Apex
Finishing Touches
Reference
Apex DML Operations
ApexPages Namespace
Approval Namespace
Auth Namespace
Canvas Namespace
ChatterAnswers Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
AuthenticationCapability Enum
AuthenticationProtocol Enum
Capability Enum
Column Class
ColumnSelection Class
Connection Class
ConnectionParams Class
DataSourceUtil Class
DataType Enum
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
TableSelection Class
DataSource Exceptions
Dom Namespace
Flow Namespace
KbManagement Namespace
Messaging Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
UserProvisioning Namespace
Appendices
Glossary
PDF

Newer Version Available

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

Capability Enum

Declares which functional operations the external system supports. Also specifies required endpoint settings for the external data source definition.

Usage

The DataSource.Provider class returns DataSource.Capability enum values, which:
  • Specify the functional capabilities of the external system.
  • Determine which endpoint settings are available on the external data source definition in Salesforce.

Enum Values

The following are the values of the DataSource.Capability enum.

Value Description
QUERY_PAGINATION_SERVER_DRIVEN With server-driven paging, the external system determines the page sizes and batch boundaries. The external system's paging settings can optimize the external system's performance and improve the load times for external objects in your organization. Also, the external data set can change while your users or the Force.com platform are paging through the result set. Typically, server-driven paging adjusts batch boundaries to accommodate changing data sets more effectively than client-driven paging.

If you enable server-driven paging on an external data source, the external system ignores any batch boundaries or page sizes that are specified in queries. Also, the Apex code must generate a query token and use it to determine and fetch the next batch of results.
QUERY_TOTAL_SIZE The external system can provide the total number of rows that meet the query criteria, even when requested to return a smaller batch size. This capability enables you to simplify how you paginate results by using queryMore().
REQUIRE_ENDPOINT Requires the administrator to specify the endpoint in the URL field in the external data source definition.
REQUIRE_HTTPS Requires the endpoint URL to use secure HTTP. If REQUIRE_ENDPOINT isn’t declared, REQUIRE_HTTPS is ignored.
ROW_QUERY Allows API and SOQL queries of the external data.
SEARCH Allows SOSL and Salesforce searches of the external data.

Only text, text area, and long text area fields on external objects can be searched. If an external object has no searchable fields, searches on that object return no records.