Loading...
Searching...
No Matches
MewsRestTableDataProvider.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
namespace MewsRestDataProvider {
hashdecl MewsTableApiConfig {
string table;
string path;
string body_key;
hash<string, bool> comparison_fields;
hash<string, bool> equality_fields;
hash<string, bool> equality_list_fields;
hash<string, bool> extent;
hash<string, bool> default_extent;
date max_delta = 3M;
bool no_limitation;
}
class MewsRestTableDataProvider : public MewsRestDataProviderBase {
public:
const ConstructorOptions = ...;
const Expressions = ...;
const SearchOptions = ...;
const UTC = new TimeZone("UTC");
protected:
hash<MewsTableApiConfig> config;
hash<string, AbstractDataField> record_type;
hash<string, bool> comp_start;
hash<string, bool> comp_end;
public:
constructor(*hash<auto> options, hash<MewsTableApiConfig> config);
constructor(MewsRestClient rest, hash<MewsTableApiConfig> config) ;
string getName();
protected:
DataProvider::AbstractDataProviderRecordIterator searchRecordsImpl(*hash<auto> where_cond, *hash<auto> search_options);
public:
protected:
AbstractDataProviderBulkRecordInterface searchRecordsBulkImpl(int block_size = 1000, *hash<auto> where_cond, *hash<auto> search_options);
public:
protected:
*hash<string, DataProvider::AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
public:
protected:
AbstractDataProvider getTableDataProvider();
public:
protected:
setRecordTypeIntern();
public:
protected:
*hash<auto> getSearchRequest(int limit, reference<*hash<auto>> where_cond, *hash<auto> search_options);
public:
protected:
processSearchArgs(reference<hash<auto>> req, hash<auto> exp);
public:
bool searchAcceptsForeignField(string field);
protected:
processEqualityArgs(reference<hash<auto>> req, hash<auto> exp);
public:
protected:
processExtent(reference<hash<auto>> req, auto val);
public:
protected:
processComparisonArgs(reference<hash<auto>> req, hash<auto> exp);
public:
};
}
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