| Qore MewsRestDataProvider Module Reference 1.0

Loading...
Searching...
No Matches
MewsRestTableDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
24
26 namespace MewsRestDataProvider {
28hashdecl MewsTableApiConfig {
30 string table;
31
33 string path;
34
36 string body_key;
37
39 hash<string, bool> comparison_fields;
40
42 hash<string, bool> equality_fields;
43
45 hash<string, bool> equality_list_fields;
46
48 hash<string, bool> extent;
49
51 hash<string, bool> default_extent;
52
54 date max_delta = 3M;
55
57 bool no_limitation;
58}
59
61 class MewsRestTableDataProvider : public MewsRestDataProviderBase {
62
63 public:
65 const ConstructorOptions = ...;
66
67
69 const Expressions = ...;
70
71
73 const SearchOptions = ...;
74
75
77 const UTC = new TimeZone("UTC");
78
79 protected:
81 hash<MewsTableApiConfig> config;
82
84 hash<string, AbstractDataField> record_type;
85
87 hash<string, bool> comp_start;
88
90 hash<string, bool> comp_end;
91
92 public:
93
95 constructor(*hash<auto> options, hash<MewsTableApiConfig> config);
96
97
99 constructor(MewsRestClient rest, hash<MewsTableApiConfig> config) ;
100
101
103 string getName();
104
105
107
112 protected:
113 DataProvider::AbstractDataProviderRecordIterator searchRecordsImpl(*hash<auto> where_cond, *hash<auto> search_options);
114 public:
115
116
117 protected:
118 AbstractDataProviderBulkRecordInterface searchRecordsBulkImpl(int block_size = 1000, *hash<auto> where_cond, *hash<auto> search_options);
119 public:
120
121
122 protected:
123 *hash<string, DataProvider::AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
124 public:
125
126
128 protected:
129 AbstractDataProvider getTableDataProvider();
130 public:
131
132
134 protected:
135 setRecordTypeIntern();
136 public:
137
138
139 protected:
140 *hash<auto> getSearchRequest(int limit, reference<*hash<auto>> where_cond, *hash<auto> search_options);
141 public:
142
143
144 protected:
145 processSearchArgs(reference<hash<auto>> req, hash<auto> exp);
146 public:
147
148
150 bool searchAcceptsForeignField(string field);
151
152
153 protected:
154 processEqualityArgs(reference<hash<auto>> req, hash<auto> exp);
155 public:
156
157
158 protected:
159 processExtent(reference<hash<auto>> req, auto val);
160 public:
161
162
163 protected:
164 processComparisonArgs(reference<hash<auto>> req, hash<auto> exp);
165 public:
166
167};
168}
MewsRestDataProvider::MewsRestDataProviderBase
The MewsRest data provider base class.
Definition MewsRestDataProviderBase.qc.dox.h:28
MewsRestDataProvider::MewsRestTableDataProvider
The MewsRestTableDataProvider data provider class.
Definition MewsRestTableDataProvider.qc.dox.h:61
MewsRestDataProvider::MewsRestTableDataProvider::ConstructorOptions
const ConstructorOptions
Constructor options.
Definition MewsRestTableDataProvider.qc.dox.h:65
MewsRestDataProvider::MewsRestTableDataProvider::setRecordTypeIntern
setRecordTypeIntern()
Retrieve the record information.
MewsRestDataProvider::MewsRestTableDataProvider::comp_end
hash< string, bool > comp_end
Comparison ...End fields.
Definition MewsRestTableDataProvider.qc.dox.h:90
MewsRestDataProvider::MewsRestTableDataProvider::constructor
constructor(*hash< auto > options, hash< MewsTableApiConfig > config)
Creates the object from constructor options.
MewsRestDataProvider::MewsRestTableDataProvider::comp_start
hash< string, bool > comp_start
Comparison ...Start fields.
Definition MewsRestTableDataProvider.qc.dox.h:87
MewsRestDataProvider::MewsRestTableDataProvider::Expressions
const Expressions
Supported Expressions.
Definition MewsRestTableDataProvider.qc.dox.h:69
MewsRestDataProvider::MewsRestTableDataProvider::getName
string getName()
Returns the data provider name.
MewsRestDataProvider::MewsRestTableDataProvider::getTableDataProvider
AbstractDataProvider getTableDataProvider()
Retrieves the Swagger data provider for the table data.
MewsRestDataProvider::MewsRestTableDataProvider::SearchOptions
const SearchOptions
Search options.
Definition MewsRestTableDataProvider.qc.dox.h:73
MewsRestDataProvider::MewsRestTableDataProvider::record_type
hash< string, AbstractDataField > record_type
Record info for the table.
Definition MewsRestTableDataProvider.qc.dox.h:84
MewsRestDataProvider::MewsRestTableDataProvider::constructor
constructor(MewsRestClient rest, hash< MewsTableApiConfig > config)
Creates the object from the arguments.
MewsRestDataProvider::MewsRestTableDataProvider::searchAcceptsForeignField
bool searchAcceptsForeignField(string field)
Allows data providers to accept foreign or virtual field names.
MewsRestDataProvider::MewsRestTableDataProvider::config
hash< MewsTableApiConfig > config
The table config.
Definition MewsRestTableDataProvider.qc.dox.h:81
MewsRestDataProvider::MewsRestTableDataProvider::searchRecordsImpl
DataProvider::AbstractDataProviderRecordIterator searchRecordsImpl(*hash< auto > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
MewsRestDataProvider::MewsRestTableDataProvider::UTC
const UTC
UTC time zone.
Definition MewsRestTableDataProvider.qc.dox.h:77
MewsRestDataProvider
Qore MewsRestDataProvider module definition.
Definition MewsRestAccountNotesTableDataProvider.qc.dox.h:26
MewsRestDataProvider::equality_fields
hash< string, bool > equality_fields
Set of fields that can support equality checks in requests.
Definition MewsRestTableDataProvider.qc.dox.h:42
MewsRestDataProvider::extent
hash< string, bool > extent
Supported extent.
Definition MewsRestTableDataProvider.qc.dox.h:48
MewsRestDataProvider::no_limitation
bool no_limitation
Does not support the "Limitation" option.
Definition MewsRestTableDataProvider.qc.dox.h:57
MewsRestDataProvider::comparison_fields
hash< string, bool > comparison_fields
Set of fields that can support date/time comparisons in requests.
Definition MewsRestTableDataProvider.qc.dox.h:39
MewsRestDataProvider::body_key
string body_key
Data key in message body.
Definition MewsRestTableDataProvider.qc.dox.h:36
MewsRestDataProvider::max_delta
date max_delta
Maximum time difference for searches.
Definition MewsRestTableDataProvider.qc.dox.h:54
MewsRestDataProvider::path
string path
Child data provider path.
Definition MewsRestTableDataProvider.qc.dox.h:33
MewsRestDataProvider::default_extent
hash< string, bool > default_extent
Default extent.
Definition MewsRestTableDataProvider.qc.dox.h:51
MewsRestDataProvider::MewsTableApiConfig
hashdecl MewsTableApiConfig
Table API config.
Definition MewsRestTableDataProvider.qc.dox.h:28
MewsRestDataProvider::equality_list_fields
hash< string, bool > equality_list_fields
Set of fields that can support list equality checks in requests.
Definition MewsRestTableDataProvider.qc.dox.h:45