AbstractBDCConnector Class

AbstractBDCConnector Methods

The following are the methods for the AbstractBDCConnector class. All methods are instance methods.

getTransactions(BDCServiceOptions options)

Signature

abstract global List<HttpResponse> getTransactions(BDCServiceOptions options)

Return Value
Type: [List<HttpResponse>]

Parameters Type: BDCServiceOptions options

Usage

getTransactions is a core and important function that will request transactions from the external service. Notice that the BDCService options provides a set of parameter that may but not necessarily will affect things like how many and the time period of the transactions in the response. Most of the parameters will likely need to be implemented to support the asynchronous retrieval of records and to stay within the limits of Salesforce and the API.

getFinancialInstitutionIdentities()

Signature

abstract global List<HttpResponse> getFinancialInstitutionIdentities()

Return Value
Type: [List<HttpResponse>]

Usage

Retrieves a list of all financial institution identity information as an array of httpResponses. May require multiple api calls.

getFinancialInstitutions(List<BDCFinancialInstitutionIdentity> finInstIdens)

Signature

abstract global List<HttpResponse> getFinancialInstitutions(List<BDCFinancialInstitutionIdentity> finInstIdens);

Return Value
Type: [List<HttpResponse>]

Parameters Type: List<BDCFinancialInstitutionIdentity>

Usage

Retrieves financial institution information as httpResponses

getFinancialInstitution(string FinInstID)

Signature

abstract global List<HttpResponse> getFinancialInstitution(string FinInstID)

Return Value
Type: [List<HttpResponse>]

Parameters Type: [FinInstID]

Usage

Takes a single financial institution Id as a string and returns financial institution information as an HttpResponse. Usually will only have one response.

deleteFinancialInstitutionIdentity(BDCFinancialInstitutionIdentity finInstIden)

Signature

abstract global List<HttpResponse> deleteFinancialInstitutionIdentity(BDCFinancialInstitutionIdentity finInstIden);

Return Value
Type: [List<HttpResponse>]

Parameters Type: BDCFinancialInstitutionIdentity

Usage

Makes an api call to delete a financial Institution Identity. Response should indicate whether the deletion was a success or not.

getAccounts(list<string> BDCAccountIds)

Signature

abstract global List<HttpResponse> getAccounts(list<string> BDCAccountIds);

Return Value
Type: [List<HttpResponse>]

Parameters Type: list<string> BDCAccountIds

Usage

Takes a list of account ids as a string and returns the accounts' info as httpResponses.

getAccountsFromFinancialInstitutionIdentities(List<BDCFinancialInstitutionIdentity> finInstIdens)

Signature

abstract global List<HttpResponse> getAccountsFromFinancialInstitutionIdentities(List<BDCFinancialInstitutionIdentity> finInstIdens)

Return Value
Type: [List<HttpResponse>]

Parameters Type: List<BDCFinancialInstitutionIdentity>

Usage

Returns accounts for a set of financial Institution Identities.

getCategories()

Signature

abstract global List<HttpResponse> getCategories();

Return Value
Type: [List<HttpResponse>]

Usage

Returns httpResponses that contain all category information used to populate transactions.

maxTransactionRecordsPerCallout()

Signature

abstract global Integer maxTransactionRecordsPerCallout()

Return Value
Type: [Integer]

Usage

Returns the maximum number of records that should be returned from an api to the BDC service. This isn't used by any specific backend object, but will likely be necessary when implementing the AbstractBDCTransactionBulk class's function to return an institution transactions.