SoapDataProvider::SoapRequestDataProvider Class Reference

The Soap data provider class. More...

#include <SoapRequestDataProvider.qc.dox.h>

Inheritance diagram for SoapDataProvider::SoapRequestDataProvider:

Public Member Methods
void	constructor (WSOperation op, WebService webservice, soft< SoapClient > soapclient)
	Creates the object from the arguments.
string	getName ()
	Returns the data provider name.
hash< DataProviderInfo >	getInfo ()
	Returns data provider info.
soft< hash< string, AbstractDataField > >	getRecordTypeImpl (soft< hash< auto > > search_options)
	Returns the description of the record type, if any.
soft< AbstractDataProviderType >	getRequestTypeImpl ()
	Returns the description of a successful request message, if any.
soft< AbstractDataProviderType >	getResponseTypeImpl ()
	Returns the description of a response message, if this object represents a response message.
soft< hash< string, AbstractDataProviderType > >	getErrorResponseTypesImpl ()
	Returns a hash of error responses, if any.
auto	doRequestImpl (auto req, soft< hash< auto > > request_options)
	Makes a request and returned the response.
AbstractDataProviderRecordIterator	requestSearchRecordsImpl (soft< hash< auto > > search_options, auto req, soft< hash< auto > > where_cond)
	Returns an iterator for zero or more records matching the search options.
AbstractDataProviderRecordIterator	searchRecordsImpl (soft< hash< auto > > where_cond, soft< hash< auto > > search_options)
	Returns an iterator for zero or more records matching the search options.
auto	doRequestIntern (auto req, soft< 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.
soft< hash< string, hash< DataProviderOptionInfo > > >	getApiOptions ()
	Returns API options for the current operation.
soft< hash< string, AbstractDataField > >	getRecordTypeIntern ()
	Returns the description of the record type, if any.
Public Member Methods inherited from SoapDataProvider::SoapDataProviderBase
void	constructor (WebService webservice, WSOperation op)
	Creates the object from the arguments.
WebService	getWebService ()
	Returns the WebService object.
WSOperation	getOperation ()
	Returns the option object.
hash< DataProviderInfo >	getStaticInfoImpl ()
	Returns data provider static info.

Public Attributes
soft< SoapClient >	soapclient
	The SOAP client object for API calls.
soft< hash< string, AbstractDataField > >	record_type
	If the request supports a list of hashes in the response and therefore the record API.

Additional Inherited Members
Private Attributes inherited from SoapDataProvider::SoapDataProviderBase
WebService	webservice
	The WebService object.
WSOperation	op
	The operation object.

Detailed Description

The Soap data provider class.

Member Function Documentation

doRequestImpl()

auto SoapDataProvider::SoapRequestDataProvider::doRequestImpl	(	auto	req,
		soft< hash< auto > >	request_options
	)

Makes a request and returned the response.

Parameters

req	the request to serialize and make according to the request type
request_options	the request options; will be processed by validateRequestOptions()

Returns

the response to the request

getRecordTypeImpl()

soft< hash< string, AbstractDataField > > SoapDataProvider::SoapRequestDataProvider::getRecordTypeImpl

(

soft< hash< auto > >

search_options

)

Returns the description of the record type, if any.

Returns the record type description for any successful response

getResponseTypeImpl()

soft< AbstractDataProviderType > SoapDataProvider::SoapRequestDataProvider::getResponseTypeImpl

(

)

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

Returns

the response type for this response message

Exceptions

INVALID-OPERATION

the data provider does not support the request API

requestSearchRecordsImpl()

AbstractDataProviderRecordIterator SoapDataProvider::SoapRequestDataProvider::requestSearchRecordsImpl	(	soft< hash< auto > >	search_options,
		auto	req,
		soft< hash< auto > >	where_cond
	)

Returns an iterator for zero or more records matching the search options.

Parameters

req	the request to serialize and make according to the request type
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

Exceptions

SWAGGER-SEARCH-ERROR

the response type exists but is not list or hash and therefore does not support searching

searchRecordsImpl()

AbstractDataProviderRecordIterator SoapDataProvider::SoapRequestDataProvider::searchRecordsImpl	(	soft< hash< auto > >	where_cond,
		soft< hash< auto > >	search_options
	)

Returns an iterator for zero or more records matching the search options.

Parameters

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

---

The documentation for this class was generated from the following file:

• doxygen/qlib/SoapDataProvider/SoapRequestDataProvider.qc.dox.h