Qore SalesforceRestDataProvider Module Reference
1.0.1
|
Defines the record iterator class for Table-based iterators. More...
Inherits AbstractDataProviderRecordIterator.
Public Member Methods | |
constructor (SalesforceRestClient rest, string name, hash< SalesforceRestRecordInfo > record_info, *hash< auto > where_cond, *hash< auto > search_options) | |
creates the iterator More... | |
string | getOrClause (list< auto > arglist) |
Returns "or" clauses. | |
*hash< string, AbstractDataField > | getRecordType () |
Returns the record description, if available. More... | |
hash< auto > | getValue () |
Returns a single record if the iterator is valid. More... | |
string | makeQuery (*hash< auto > where_cond, *hash< auto > search_options) |
Returns the SQL for a request. | |
auto | memberGate (string key) |
Returns the value of the given field in the current row, if the iterator is valid. More... | |
bool | next () |
Increments the row pointer when retrieving rows from a select statement; returns True if there is a row to retrieve, False if not. More... | |
bool | valid () |
Returns True if the iterator is valid. More... | |
Private:Internal Attributes | |
ListHashIterator | i |
record iterator | |
string | name |
current object name | |
hash< SalesforceRestRecordInfo > | record_info |
The record info for this object. | |
SalesforceRestClient | rest |
The REST client object for API calls. | |
Defines the record iterator class for Table-based iterators.
SalesforceRestDataProvider::SalesforceRestRecordIterator::constructor | ( | SalesforceRestClient | rest, |
string | name, | ||
hash< SalesforceRestRecordInfo > | record_info, | ||
*hash< auto > | where_cond, | ||
*hash< auto > | search_options | ||
) |
creates the iterator
rest | the REST client connection to the server |
name | the name of the object |
record_info | info about the current object |
where_cond | the search conditions |
search_options | search options; assumed to have already been processed for validity before this call |
*hash<string, AbstractDataField> SalesforceRestDataProvider::SalesforceRestRecordIterator::getRecordType | ( | ) |
Returns the record description, if available.
hash<auto> SalesforceRestDataProvider::SalesforceRestRecordIterator::getValue | ( | ) |
Returns a single record if the iterator is valid.
INVALID-ITERATOR | the iterator is not pointing at a valid element |
auto SalesforceRestDataProvider::SalesforceRestRecordIterator::memberGate | ( | string | key | ) |
Returns the value of the given field in the current row, if the iterator is valid.
key | the name of the field |
FIELD-ERROR | invalid or unknown field name |
bool SalesforceRestDataProvider::SalesforceRestRecordIterator::next | ( | ) |