RemoteApiProvider::RemoteApiDataProvider Class Reference

The remote Qorus API data provider class, provides remote Qorus API endpoints as children. More...

Inherits AbstractDataProvider.

Public Member Methods
	constructor (string remote, QorusSystemRestHelper qrest, string path)
	creates the object
	constructor (*hash< auto > options)
	Creates the object from constructor options.
string	getName ()
	Returns the remote connection name.
*string	getDesc ()
	Returns the data provider description.

Static Public Member Methods
static *DataProvider::AbstractDataProviderType	getTypeFromInfo (*hash< auto > info)
	Returns a type object from a type description hash.
static DataProvider::HashDataType	getHashTypeFromInfo (hash< auto > info)
	Returns a hash type from a type description hash.

Public Attributes
const	ProviderInfo
	Provider info.
const	ConstructorOptions
	Constructor options.

Private Member Methods
*list< string >	getChildProviderNamesImpl ()
	Returns a list of child data provider names. More...
*DataProvider::AbstractDataProvider	getChildProviderImpl (string name)
	Returns the given child provider or NOTHING if the given child is unknown. More...
hash< DataProvider::DataProviderInfo >	getStaticInfoImpl ()
	Returns data provider static info.
auto	doRequestImpl (auto req, *hash< auto > request_options)
	Makes a request and returns the response. More...
*DataProvider::AbstractDataProviderType	getRequestTypeImpl ()
	Returns the description of a successful request message, if any. More...
*DataProvider::AbstractDataProviderType	getResponseTypeImpl ()
	Returns the description of a response message, if this object represents a response message. More...
string	getUriPath ()
	Returns the URI path segment for this provider.

Private Attributes
string	remote
	The remote connection name.
QorusSystemRestHelper	qrest
	The remote connection.
string	path
	The path to the API.

Detailed Description

The remote Qorus API data provider class, provides remote Qorus API endpoints as children.

Member Function Documentation

doRequestImpl()

auto RemoteApiProvider::RemoteApiDataProvider::doRequestImpl ( auto  req, *hash< auto >  request_options  )

private

Makes a request and returns 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

getChildProviderImpl()

*DataProvider::AbstractDataProvider RemoteApiProvider::RemoteApiDataProvider::getChildProviderImpl ( string  name )

private

Returns the given child provider or NOTHING if the given child is unknown.

Returns

the given child provider or NOTHING if the given child is unknown

Exceptions

CHILD-PROVIDER-ERROR

error acquiring child provider

See also

getChildProviderEx()

getChildProviderNamesImpl()

*list< string > RemoteApiProvider::RemoteApiDataProvider::getChildProviderNamesImpl ( )

private

Returns a list of child data provider names.

Returns

a list of child data provider names

getRequestTypeImpl()

*DataProvider::AbstractDataProviderType RemoteApiProvider::RemoteApiDataProvider::getRequestTypeImpl ( )

private

Returns the description of a successful request message, if any.

Returns

the request type for this provider

Note

only called if the provider supports the request / response API

getResponseTypeImpl()

*DataProvider::AbstractDataProviderType RemoteApiProvider::RemoteApiDataProvider::getResponseTypeImpl ( )

private

Returns the description of a response message, if this object represents a response message.

Returns

the response type for this response message

Note

only called if the provider supports the request / response API

---

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

• RemoteApiDataProvider.qc