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