Qore SoapDataProvider Module Reference
1.0
|
The Soap data provider class. More...
Public Member Methods | |
constructor (WebService webservice, *SoapClient soapclient, WSOperation op) | |
Creates the object from the arguments. | |
string | getName () |
Returns the data provider name. | |
hash< DataProviderInfo > | getInfo () |
Returns data provider info. | |
Public Member Methods inherited from SoapDataProvider::SoapDataProviderBase | |
constructor (WebService webservice, WSOperation op) | |
Creates the object from the arguments. | |
Public Attributes | |
*SoapClient | soapclient |
The SOAP client object for API calls. | |
*hash< string, AbstractDataField > | record_type |
If the request supports a list of hashes in the response and therefore the record API. | |
Private Member Methods | |
*hash< string, AbstractDataField > | getRecordTypeImpl (*hash< auto > search_options) |
Returns the description of the record type, if any. More... | |
*AbstractDataProviderType | getRequestTypeImpl () |
Returns the description of a successful request message, if any. | |
*AbstractDataProviderType | getResponseTypeImpl () |
Returns the description of a response message, if this object represents a response message. More... | |
*hash< string, AbstractDataProviderType > | getErrorResponseTypesImpl () |
Returns a hash of error responses, if any. | |
auto | doRequestImpl (auto req, *hash< auto > request_options) |
Makes a request and returned the response. More... | |
AbstractDataProviderRecordIterator | searchRecordsImpl (*hash< auto > where_cond, *hash< auto > search_options) |
Returns an iterator for zero or more records matching the search options. More... | |
hash< auto > | doRequestIntern (auto req, *hash< auto > options) |
Makes a REST request and returns the response. | |
SoapClient | getSoapClient () |
Returns a REST client for HTTP operations. | |
hash< DataProviderInfo > | getStaticInfoImpl () |
Returns data provider static info. | |
*hash< string, hash< DataProviderOptionInfo > > | getApiOptions () |
Returns API options for the current operation. | |
Private Member Methods inherited from SoapDataProvider::SoapDataProviderBase | |
hash< DataProviderInfo > | getStaticInfoImpl () |
Returns data provider static info. | |
Private:Internal Member Methods | |
*hash< string, AbstractDataField > | getRecordTypeIntern () |
Returns the description of the record type, if any. | |
Additional Inherited Members | |
Private Attributes inherited from SoapDataProvider::SoapDataProviderBase | |
WebService | webservice |
The WebService object. | |
WSOperation | op |
The operation object. | |
The Soap data provider class.
|
private |
Makes a request and returned the response.
req | the request to serialize and make according to the request type |
request_options | the request options; will be processed by validateRequestOptions() |
|
private |
Returns the description of the record type, if any.
Returns the record type description for any successful response
|
private |
Returns the description of a response message, if this object represents a response message.
If the object is a request message, then any successful response message should be returned here as well
INVALID-OPERATION | the data provider does not support the request API |
|
private |
Returns an iterator for zero or more records matching the search options.
where_cond | the search criteria |
search_options | the search options after processing by validateSearchOptions() |
This will execute the request and perform a default search on any record(s) returned