Qore MewsRestDataProvider Module Reference 1.0
Loading...
Searching...
No Matches
MewsRestTableDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
24
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
63 date max_delta = 2160h;
64
67}
68
71
72public:
74 const ConstructorOptions = ...;
75
76
78 const Expressions = ...;
79
80
82 const SearchOptions = ...;
83
84
86 const UTC = new TimeZone("UTC");
87
88protected:
90 hash<MewsTableApiConfig> config;
91
93 hash<string, AbstractDataField> record_type;
94
96 hash<string, bool> comp_start;
97
99 hash<string, bool> comp_end;
100
101public:
102
104 constructor(*hash<auto> options, hash<MewsTableApiConfig> config);
105
106
108 constructor(MewsRestClient rest, hash<MewsTableApiConfig> config) ;
109
110
112 string getName();
113
114
116
121protected:
122 DataProvider::AbstractDataProviderRecordIterator searchRecordsImpl(*hash<auto> where_cond, *hash<auto> search_options);
123public:
124
125
126protected:
127 AbstractDataProviderBulkRecordInterface searchRecordsBulkImpl(int block_size = 1000, *hash<auto> where_cond, *hash<auto> search_options);
128public:
129
130
131protected:
132 *hash<string, DataProvider::AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
133public:
134
135
137protected:
138 AbstractDataProvider getTableDataProvider();
139public:
140
141
143protected:
145public:
146
147
148protected:
149 *hash<auto> getSearchRequest(int limit, reference<*hash<auto>> where_cond, *hash<auto> search_options);
150public:
151
152
153protected:
154 processSearchArgs(reference<hash<auto>> req, hash<auto> exp);
155public:
156
157
159 bool searchAcceptsForeignField(string field);
160
161
162protected:
163 processEqualityArgs(reference<hash<auto>> req, hash<auto> exp);
164public:
165
166
167protected:
168 processExtent(reference<hash<auto>> req, auto val);
169public:
170
171
172protected:
173 processComparisonArgs(reference<hash<auto>> req, hash<auto> exp);
174public:
175
176};
177}
The MewsRest data provider base class.
Definition MewsRestDataProviderBase.qc.dox.h:28
The MewsRestTableDataProvider data provider class.
Definition MewsRestTableDataProvider.qc.dox.h:70
const ConstructorOptions
Constructor options.
Definition MewsRestTableDataProvider.qc.dox.h:74
setRecordTypeIntern()
Retrieve the record information.
hash< string, bool > comp_end
Comparison ...End fields.
Definition MewsRestTableDataProvider.qc.dox.h:99
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:96
const Expressions
Supported Expressions.
Definition MewsRestTableDataProvider.qc.dox.h:78
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:82
hash< string, AbstractDataField > record_type
Record info for the table.
Definition MewsRestTableDataProvider.qc.dox.h:93
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:90
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:86
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:66
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:63
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