Qore SwaggerDataProvider Module Reference  1.0.3
SwaggerRequestDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
25 namespace SwaggerDataProvider {
29 
30 public:
32  SwaggerSchema schema;
33 
36 
38  string uri_path;
39 
42 
44  PathItemObject pio;
45 
47  OperationObject op;
48 
51 
53  *hash<string, AbstractDataField> record_type;
54 
56  constructor(SwaggerSchema schema, *RestClient rest, string uri_path, PathItemObject pio, OperationObject op);
57 
58 
60  string getName();
61 
62 
64  hash<DataProviderInfo> getInfo();
65 
66 
68 
70 protected:
71  *hash<string, AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
72 public:
73 
74 
75 protected:
76  *hash<string, AbstractDataField> getRecordTypeIntern();
77 public:
78 
79 
81 protected:
82  *AbstractDataProviderType getRequestTypeImpl();
83 public:
84 
85 
87 protected:
88  *AbstractDataProviderType getResponseTypeImpl();
89 public:
90 
91 
93 protected:
94  *hash<string, AbstractDataProviderType> getErrorResponseTypesImpl();
95 public:
96 
97 
99 
105 protected:
106  AbstractDataProviderType getErrorResponseTypeImpl(string error_code);
107 public:
108 
109 
111 protected:
112  AbstractDataProviderType getResponseTypeIntern(ResponseObject response, string label);
113 public:
114 
115 
117 protected:
118  *ResponseObject getSuccessResponse();
119 public:
120 
121 
123 
128 protected:
129  auto doRequestImpl(auto req, *hash<auto> request_options);
130 public:
131 
132 
134 
142 protected:
143  AbstractDataProviderRecordIterator requestSearchRecordsImpl(auto req, *hash<auto> where_cond, *hash<auto> search_options);
144 public:
145 
146 
148 protected:
149  hash<auto> doRequestIntern(auto req, *hash<auto> options);
150 public:
151 
152 
154  string getUriValue(auto v);
155 
156 
158 protected:
159  string getUriPath();
160 public:
161 
162 
164 protected:
166 public:
167 
168 
170 protected:
171  hash<DataProviderInfo> getStaticInfoImpl();
172 public:
173 
174 };
175 };
SwaggerDataProvider::SwaggerRequestDataProvider::getStaticInfoImpl
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
SwaggerDataProvider::SwaggerRequestDataProvider::getErrorResponseTypesImpl
*hash< string, AbstractDataProviderType > getErrorResponseTypesImpl()
Returns a hash of error responses, if any.
SwaggerDataProvider::SwaggerRequestDataProvider::rest
*RestClient rest
The REST client object for API calls.
Definition: SwaggerRequestDataProvider.qc.dox.h:35
SwaggerDataProvider::SwaggerRequestDataProvider::getRecordTypeImpl
*hash< string, AbstractDataField > getRecordTypeImpl(*hash< auto > search_options)
Returns the description of the record type, if any.
SwaggerDataProvider::SwaggerDataProviderBase
The Swagger data provider base class.
Definition: SwaggerDataProviderBase.qc.dox.h:28
SwaggerDataProvider::SwaggerRequestDataProvider::uri_path
string uri_path
The current URI path.
Definition: SwaggerRequestDataProvider.qc.dox.h:38
SwaggerDataProvider::SwaggerRequestDataProvider::record_type
*hash< string, AbstractDataField > record_type
If the request supports a list of hashes in the response and therefore the record API.
Definition: SwaggerRequestDataProvider.qc.dox.h:53
SwaggerDataProvider::SwaggerRequestDataProvider::getRestClient
RestClient getRestClient()
Returns a REST client for HTTP operations.
SwaggerDataProvider::SwaggerRequestDataProvider::doRequestIntern
hash< auto > doRequestIntern(auto req, *hash< auto > options)
Makes a REST request and returns the response.
SwaggerDataProvider::SwaggerRequestDataProvider::success_response
string success_response
The success response code, if any.
Definition: SwaggerRequestDataProvider.qc.dox.h:50
SwaggerDataProvider::SwaggerRequestDataProvider::op
OperationObject op
The operation object.
Definition: SwaggerRequestDataProvider.qc.dox.h:47
RestClient
SwaggerDataProvider::SwaggerRequestDataProvider::getUriValue
string getUriValue(auto v)
Returns the value for the given query argument.
SwaggerDataProvider::SwaggerRequestDataProvider::getUriPath
string getUriPath()
Returns the URI path to use in requests.
SwaggerDataProvider::SwaggerRequestDataProvider::doRequestImpl
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returned the response.
SwaggerDataProvider::SwaggerRequestDataProvider
The Swagger data provider class.
Definition: SwaggerRequestDataProvider.qc.dox.h:28
SwaggerDataProvider
Qore SwaggerDataProvider module definition.
Definition: SwaggerDataProvider.qc.dox.h:26
SwaggerDataProvider::SwaggerRequestDataProvider::pio
PathItemObject pio
The path item object for the operation.
Definition: SwaggerRequestDataProvider.qc.dox.h:44
SwaggerDataProvider::SwaggerRequestDataProvider::getInfo
hash< DataProviderInfo > getInfo()
Returns data provider info.
SwaggerDataProvider::SwaggerRequestDataProvider::constructor
constructor(SwaggerSchema schema, *RestClient rest, string uri_path, PathItemObject pio, OperationObject op)
Creates the object from the arguments.
SwaggerDataProvider::SwaggerRequestDataProvider::resolve_uri
bool resolve_uri
The URI needs dynamic resolution.
Definition: SwaggerRequestDataProvider.qc.dox.h:41
SwaggerDataProvider::SwaggerRequestDataProvider::requestSearchRecordsImpl
AbstractDataProviderRecordIterator requestSearchRecordsImpl(auto req, *hash< auto > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
SwaggerDataProvider::SwaggerRequestDataProvider::getErrorResponseTypeImpl
AbstractDataProviderType getErrorResponseTypeImpl(string error_code)
Returns the type for the given error code.
SwaggerDataProvider::SwaggerRequestDataProvider::getResponseTypeImpl
*AbstractDataProviderType getResponseTypeImpl()
Returns the description of a successful response message, if any.
SwaggerDataProvider::SwaggerRequestDataProvider::getRequestTypeImpl
*AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
SwaggerDataProvider::SwaggerRequestDataProvider::getResponseTypeIntern
AbstractDataProviderType getResponseTypeIntern(ResponseObject response, string label)
Returns a data provider type object for a Swagger response.
SwaggerDataProvider::SwaggerRequestDataProvider::schema
SwaggerSchema schema
The Swagger schema.
Definition: SwaggerRequestDataProvider.qc.dox.h:32
SwaggerDataProvider::SwaggerRequestDataProvider::getSuccessResponse
*ResponseObject getSuccessResponse()
Returns the schema for the first successful response message found.
SwaggerDataProvider::SwaggerRequestDataProvider::getName
string getName()
Returns the data provider name.