org.apache.camel.component.salesforce.internal.client
Interface RestClient

All Known Implementing Classes:

DefaultRestClient

public interface RestClient

Nested Class Summary

static interface

RestClient.ResponseCallback

Method Summary

void	createSObject(String sObjectName, InputStream sObject, RestClient.ResponseCallback callback) Creates a record for the specified object.
void	deleteSObject(String sObjectName, String id, RestClient.ResponseCallback callback) Deletes a record for the specified object ID.
void	deleteSObjectWithId(String sObjectName, String fieldName, String fieldValue, RestClient.ResponseCallback callback) Deletes a record based on the value of a specified external ID field.
void	getBasicInfo(String sObjectName, RestClient.ResponseCallback callback) Describes the individual metadata for the specified object.
void	getBlobField(String sObjectName, String id, String blobFieldName, RestClient.ResponseCallback callback) Retrieves the specified blob field from an individual record.
void	getDescription(String sObjectName, RestClient.ResponseCallback callback) Completely describes the individual metadata at all levels for the specified object.
void	getGlobalObjects(RestClient.ResponseCallback callback) Lists the available objects and their metadata for your organization's data.
void	getResources(RestClient.ResponseCallback callback) Lists available resources for the specified API version, including resource name and URI.
void	getSObject(String sObjectName, String id, String[] fields, RestClient.ResponseCallback callback) Retrieves a record for the specified object ID.
void	getSObjectWithId(String sObjectName, String fieldName, String fieldValue, RestClient.ResponseCallback callback) Retrieves a record for the specified external ID.
void	getVersions(RestClient.ResponseCallback callback) Lists summary information about each API version currently available, including the version, label, and a link to each version's root.
void	query(String soqlQuery, RestClient.ResponseCallback callback) Executes the specified SOQL query.
void	queryMore(String nextRecordsUrl, RestClient.ResponseCallback callback) Get SOQL query results using nextRecordsUrl.
void	search(String soslQuery, RestClient.ResponseCallback callback) Executes the specified SOSL search.
void	updateSObject(String sObjectName, String id, InputStream sObject, RestClient.ResponseCallback callback) Updates a record for the specified object ID.
void	upsertSObject(String sObjectName, String fieldName, String fieldValue, InputStream sObject, RestClient.ResponseCallback callback) Creates or updates a record based on the value of a specified external ID field.

Method Detail

getVersions

void getVersions(RestClient.ResponseCallback callback)

Lists summary information about each API version currently available, including the version, label, and a link to each version's root.

Parameters:

callback - RestClient.ResponseCallback to handle response or exception

getResources

void getResources(RestClient.ResponseCallback callback)

Lists available resources for the specified API version, including resource name and URI.

Parameters:

callback - RestClient.ResponseCallback to handle response or exception

getGlobalObjects

void getGlobalObjects(RestClient.ResponseCallback callback)

Lists the available objects and their metadata for your organization's data.

Parameters:

callback - RestClient.ResponseCallback to handle response or exception

getBasicInfo

void getBasicInfo(String sObjectName,
                  RestClient.ResponseCallback callback)

Describes the individual metadata for the specified object.

Parameters:

sObjectName - specified object name

callback - RestClient.ResponseCallback to handle response or exception

getDescription

void getDescription(String sObjectName,
                    RestClient.ResponseCallback callback)

Completely describes the individual metadata at all levels for the specified object.

Parameters:

sObjectName - specified object name

callback - RestClient.ResponseCallback to handle response or exception

getSObject

void getSObject(String sObjectName,
                String id,
                String[] fields,
                RestClient.ResponseCallback callback)

Retrieves a record for the specified object ID.

Parameters:

sObjectName - specified object name

id - object id

callback - RestClient.ResponseCallback to handle response or exception

createSObject

void createSObject(String sObjectName,
                   InputStream sObject,
                   RestClient.ResponseCallback callback)

Creates a record for the specified object.

Parameters:

sObjectName - specified object name

sObject - request entity

callback - RestClient.ResponseCallback to handle response or exception

updateSObject

void updateSObject(String sObjectName,
                   String id,
                   InputStream sObject,
                   RestClient.ResponseCallback callback)

Updates a record for the specified object ID.

Parameters:

sObjectName - specified object name

id - object id

sObject - request entity

callback - RestClient.ResponseCallback to handle response or exception

deleteSObject

void deleteSObject(String sObjectName,
                   String id,
                   RestClient.ResponseCallback callback)

Deletes a record for the specified object ID.

Parameters:

sObjectName - specified object name

id - object id

callback - RestClient.ResponseCallback to handle response or exception

getSObjectWithId

void getSObjectWithId(String sObjectName,
                      String fieldName,
                      String fieldValue,
                      RestClient.ResponseCallback callback)

Retrieves a record for the specified external ID.

Parameters:

sObjectName - specified object name

fieldName - external field name

fieldValue - external field value

callback - RestClient.ResponseCallback to handle response or exception

upsertSObject

void upsertSObject(String sObjectName,
                   String fieldName,
                   String fieldValue,
                   InputStream sObject,
                   RestClient.ResponseCallback callback)

Creates or updates a record based on the value of a specified external ID field.

Parameters:

sObjectName - specified object name

fieldName - external field name

fieldValue - external field value

sObject - input object to insert or update

callback - RestClient.ResponseCallback to handle response or exception

deleteSObjectWithId

void deleteSObjectWithId(String sObjectName,
                         String fieldName,
                         String fieldValue,
                         RestClient.ResponseCallback callback)

Deletes a record based on the value of a specified external ID field.

Parameters:

sObjectName - specified object name

fieldName - external field name

fieldValue - external field value

callback - RestClient.ResponseCallback to handle response or exception

getBlobField

void getBlobField(String sObjectName,
                  String id,
                  String blobFieldName,
                  RestClient.ResponseCallback callback)

Retrieves the specified blob field from an individual record.

query

void query(String soqlQuery,
           RestClient.ResponseCallback callback)

Executes the specified SOQL query.

Parameters:

soqlQuery - SOQL query

callback - RestClient.ResponseCallback to handle response or exception

queryMore

void queryMore(String nextRecordsUrl,
               RestClient.ResponseCallback callback)

Get SOQL query results using nextRecordsUrl.

Parameters:

nextRecordsUrl - URL for next records to fetch, returned by query()

callback - RestClient.ResponseCallback to handle response or exception

search

void search(String soslQuery,
            RestClient.ResponseCallback callback)

Executes the specified SOSL search.

Parameters:

soslQuery - SOSL query

callback - RestClient.ResponseCallback to handle response or exception