Qore SoapDataProvider Module Reference  1.0
SoapOperationDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
25 // minimum required Qore version
26 // assume local scope for variables, do not use "$" signs
27 // require type definitions everywhere
28 // strict argument handling
29 // enable all warnings
30 
32 namespace SoapDataProvider {
35 
36 public:
38  *SoapClient soapclient;
39 
41  *hash<string, AbstractDataField> record_type;
42 
44  constructor(WebService webservice, *SoapClient soapclient, WSOperation op) ;
45 
46 
48  string getName();
49 
50 
52  hash<DataProviderInfo> getInfo();
53 
54 
56 
58 protected:
59  *hash<string, AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
60 public:
61 
62 
64 protected:
65  *AbstractDataProviderType getRequestTypeImpl();
66 public:
67 
68 
70 
76 protected:
77  *AbstractDataProviderType getResponseTypeImpl();
78 public:
79 
80 
82 protected:
83  *hash<string, AbstractDataProviderType> getErrorResponseTypesImpl();
84 public:
85 
86 
88 
93 protected:
94  auto doRequestImpl(auto req, *hash<auto> request_options);
95 public:
96 
97 
99 
104 protected:
105  AbstractDataProviderRecordIterator searchRecordsImpl(*hash<auto> where_cond, *hash<auto> search_options);
106 public:
107 
108 
110 protected:
111  hash<auto> doRequestIntern(auto req, *hash<auto> options);
112 public:
113 
114 
116 protected:
117  SoapClient getSoapClient();
118 public:
119 
120 
122 protected:
123  hash<DataProviderInfo> getStaticInfoImpl();
124 public:
125 
126 
128 protected:
129  *hash<string, hash<DataProviderOptionInfo>> getApiOptions();
130 public:
131 
132 
134 private:
135  *hash<string, AbstractDataField> getRecordTypeIntern();
136 public:
137 
138 };
139 };
The Soap data provider base class.
Definition: SoapDataProviderBase.qc.dox.h:34
WebService webservice
The WebService object.
Definition: SoapDataProviderBase.qc.dox.h:39
WSOperation op
The operation object.
Definition: SoapDataProviderBase.qc.dox.h:42
The Soap data provider class.
Definition: SoapOperationDataProvider.qc.dox.h:34
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returned the response.
AbstractDataProviderRecordIterator searchRecordsImpl(*hash< auto > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
*hash< string, AbstractDataField > record_type
If the request supports a list of hashes in the response and therefore the record API.
Definition: SoapOperationDataProvider.qc.dox.h:41
*hash< string, hash< DataProviderOptionInfo > > getApiOptions()
Returns API options for the current operation.
*hash< string, AbstractDataProviderType > getErrorResponseTypesImpl()
Returns a hash of error responses, if any.
*hash< string, AbstractDataField > getRecordTypeIntern()
Returns the description of the record type, if any.
string getName()
Returns the data provider name.
constructor(WebService webservice, *SoapClient soapclient, WSOperation op)
Creates the object from the arguments.
*AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
*AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
SoapClient getSoapClient()
Returns a REST client for HTTP operations.
hash< DataProviderInfo > getInfo()
Returns data provider info.
*hash< string, AbstractDataField > getRecordTypeImpl(*hash< auto > search_options)
Returns the description of the record type, if any.
hash< auto > doRequestIntern(auto req, *hash< auto > options)
Makes a REST request and returns the response.
*SoapClient soapclient
The SOAP client object for API calls.
Definition: SoapOperationDataProvider.qc.dox.h:38
Qore SoapDataProvider module definition.
Definition: SoapDataProvider.qc.dox.h:32