| Qore SalesforceRestDataProvider Module Reference 2.0

Loading...
Searching...
No Matches
SalesforceRestDataProviderDefs.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
24
26 namespace SalesforceRestDataProvider {
28 public struct SoqlOperatorInfo {
29 string op;
30 auto arg;
31};
32
34 public struct SoqlColumnOperatorInfo {
35 string cop;
36 auto column;
37 auto arg;
38};
39
45
47 const SOQL_COP_MIN = "min";
48
50
52 const SOQL_COP_MAX = "max";
53
55
57 const SOQL_COP_AVG = "avg";
58
60
62 const SOQL_COP_SUM = "sum";
63
65
67 const SOQL_COP_COUNT = "count";
68
70
72 const SOQL_COP_COUNT_DISTINCT = "count_distinct";
73
75
77 const SOQL_COP_FORMAT = "format";
78
80
82 const SOQL_COP_CONVERT_CURRENCY = "convert_currency";
83
85
87 const SOQL_COP_CALENDAR_MONTH = "calendar_month";
88
90
92 const SOQL_COP_CALENDAR_QUARTER = "calendar_quarter";
93
95
97 const SOQL_COP_CALENDAR_YEAR = "calendar_year";
98
100
102 const SOQL_COP_DAY_IN_MONTH = "day_in_month";
103
105
107 const SOQL_COP_DAY_IN_WEEK = "day_in_week";
108
110
112 const SOQL_COP_DAY_IN_YEAR = "day_in_year";
113
115
117 const SOQL_COP_DAY_ONLY = "day_only";
118
120
122 const SOQL_COP_FISCAL_MONTH = "fiscal_month";
123
125
127 const SOQL_COP_FISCAL_QUARTER = "fiscal_quarter";
128
130
132 const SOQL_COP_FISCAL_YEAR = "fiscal_year";
133
135
137 const SOQL_COP_HOUR_IN_DAY = "hour_in_day";
138
140
142 const SOQL_COP_WEEK_IN_MONTH = "week_in_month";
143
145
147 const SOQL_COP_WEEK_IN_YEAR = "week_in_year";
148
150 const DefaultSoqlCopMap = ...;
151
153
159 const SOQL_OP_LIKE = "like";
160
162
164 const SOQL_OP_IN = "in";
165
167
169 const SOQL_OP_NOT_IN = "not in";
170
172
174 const SOQL_OP_LT = "<";
175
177
179 const SOQL_OP_LE = "<=";
180
182
184 const SOQL_OP_GT = ">";
185
187
189 const SOQL_OP_GE = ">=";
190
192
194 const SOQL_OP_NE = "!=";
195
197
199 const SOQL_OP_EQ = "=";
200
202
204 const SOQL_OP_NOT = "not";
205
207
209 const SOQL_OP_OR = "or";
211
238
247 hash<SoqlColumnOperatorInfo> soql_make_cop(string cop, auto column, auto arg);
248
249
251
261 hash<SoqlColumnOperatorInfo> soql_cop_min(auto column);
262
263
265
275 hash<SoqlColumnOperatorInfo> soql_cop_max(auto column);
276
277
279
289 hash<SoqlColumnOperatorInfo> soql_cop_avg(auto column);
290
291
293
303 hash<SoqlColumnOperatorInfo> soql_cop_sum(auto column);
304
305
307
315 hash<SoqlColumnOperatorInfo> soql_cop_count(auto column = '');
316
317
319
327 hash<SoqlColumnOperatorInfo> soql_cop_count_distinct(auto column = '');
328
329
331
344 hash<SoqlColumnOperatorInfo> soql_cop_format(auto column);
345
346
348
358 hash<SoqlColumnOperatorInfo> soql_cop_convert_currency(auto column);
359
360
362
370 hash<SoqlColumnOperatorInfo> soql_cop_calendar_month(auto column);
371
372
374
382 hash<SoqlColumnOperatorInfo> soql_cop_calendar_quarter(auto column);
383
384
386
394 hash<SoqlColumnOperatorInfo> soql_cop_calendar_year(auto column);
395
396
398
406 hash<SoqlColumnOperatorInfo> soql_cop_day_in_month(auto column);
407
408
410
418 hash<SoqlColumnOperatorInfo> soql_cop_day_in_week(auto column);
419
420
422
430 hash<SoqlColumnOperatorInfo> soql_cop_day_in_year(auto column);
431
432
434
442 hash<SoqlColumnOperatorInfo> soql_cop_day_only(auto column);
443
444
446
454 hash<SoqlColumnOperatorInfo> soql_cop_fiscal_month(auto column);
455
456
458
466 hash<SoqlColumnOperatorInfo> soql_cop_fiscal_quarter(auto column);
467
468
470
478 hash<SoqlColumnOperatorInfo> soql_cop_fiscal_year(auto column);
479
480
482
490 hash<SoqlColumnOperatorInfo> soql_cop_hour_in_day(auto column);
491
492
494
502 hash<SoqlColumnOperatorInfo> soql_cop_week_in_month(auto column);
503
504
506
514 hash<SoqlColumnOperatorInfo> soql_cop_week_in_year(auto column);
515
517
534 hash<SoqlOperatorInfo> soql_make_op(string op, auto arg);
535
536
538
547 hash<SoqlOperatorInfo> soql_op_like(string str);
548
549
551
560 hash<SoqlOperatorInfo> soql_op_lt(auto arg);
561
562
564
573 hash<SoqlOperatorInfo> soql_op_le(auto arg);
574
575
577
586 hash<SoqlOperatorInfo> soql_op_gt(auto arg);
587
588
590
599 hash<SoqlOperatorInfo> soql_op_ge(auto arg);
600
601
603
610 hash<SoqlOperatorInfo> soql_op_ne(auto arg);
611
612
614
623 hash<SoqlOperatorInfo> soql_op_eq(auto arg);
624
625
627
636 hash<SoqlOperatorInfo> soql_op_in();
637
638
640
651 hash<SoqlOperatorInfo> soql_op_in(list<auto> args);
652
653
655
664 hash<SoqlOperatorInfo> soql_op_not_in();
665
666
668
679 hash<SoqlOperatorInfo> soql_op_not_in(list<auto> args);
680
681
683
690 hash<SoqlOperatorInfo> soql_op_not(hash arg);
691
692
694
713 hash<string, hash<SoqlOperatorInfo>> soql_wop_or(hash<auto> h1, hash<auto> h2);
714
716
718 const DefaultSoqlOpMap = ...;
719
721};
SalesforceRestDataProvider::SOQL_COP_FISCAL_QUARTER
const SOQL_COP_FISCAL_QUARTER
to return the fiscal quarter of a date or date/time value
Definition SalesforceRestDataProviderDefs.qc.dox.h:127
SalesforceRestDataProvider::SOQL_COP_AVG
const SOQL_COP_AVG
to return the average value
Definition SalesforceRestDataProviderDefs.qc.dox.h:57
SalesforceRestDataProvider::SOQL_COP_FISCAL_MONTH
const SOQL_COP_FISCAL_MONTH
to return the fiscal month of a date or date/time value
Definition SalesforceRestDataProviderDefs.qc.dox.h:122
SalesforceRestDataProvider::SOQL_COP_CALENDAR_YEAR
const SOQL_COP_CALENDAR_YEAR
to return the calendar year of a date or date/time value
Definition SalesforceRestDataProviderDefs.qc.dox.h:97
SalesforceRestDataProvider::SOQL_COP_DAY_IN_WEEK
const SOQL_COP_DAY_IN_WEEK
to return the day in the week of a date or date/time value (1 = Sunday, 7 = Saturday)
Definition SalesforceRestDataProviderDefs.qc.dox.h:107
SalesforceRestDataProvider::DefaultSoqlCopMap
const DefaultSoqlCopMap
a hash of default column operator descriptions
Definition SalesforceRestDataProviderDefs.qc.dox.h:150
SalesforceRestDataProvider::SOQL_COP_CALENDAR_QUARTER
const SOQL_COP_CALENDAR_QUARTER
to return the calendar quarter of a date or date/time value
Definition SalesforceRestDataProviderDefs.qc.dox.h:92
SalesforceRestDataProvider::SOQL_COP_FORMAT
const SOQL_COP_FORMAT
to return the given column value in the default locale for number, date, time, and currency fields
Definition SalesforceRestDataProviderDefs.qc.dox.h:77
SalesforceRestDataProvider::SOQL_COP_MIN
const SOQL_COP_MIN
Definition SalesforceRestDataProviderDefs.qc.dox.h:47
SalesforceRestDataProvider::SOQL_COP_DAY_IN_YEAR
const SOQL_COP_DAY_IN_YEAR
to return the day in the year of a date or date/time value
Definition SalesforceRestDataProviderDefs.qc.dox.h:112
SalesforceRestDataProvider::SOQL_COP_COUNT
const SOQL_COP_COUNT
to return the row count
Definition SalesforceRestDataProviderDefs.qc.dox.h:67
SalesforceRestDataProvider::SOQL_COP_CONVERT_CURRENCY
const SOQL_COP_CONVERT_CURRENCY
to return the given column value in the default currency for the calling user
Definition SalesforceRestDataProviderDefs.qc.dox.h:82
SalesforceRestDataProvider::SOQL_COP_FISCAL_YEAR
const SOQL_COP_FISCAL_YEAR
to return the fiscal year of a date or date/time value
Definition SalesforceRestDataProviderDefs.qc.dox.h:132
SalesforceRestDataProvider::SOQL_COP_CALENDAR_MONTH
const SOQL_COP_CALENDAR_MONTH
to return the calendar month of a date or date/time value
Definition SalesforceRestDataProviderDefs.qc.dox.h:87
SalesforceRestDataProvider::SOQL_COP_MAX
const SOQL_COP_MAX
to return the maximum value
Definition SalesforceRestDataProviderDefs.qc.dox.h:52
SalesforceRestDataProvider::SOQL_COP_COUNT_DISTINCT
const SOQL_COP_COUNT_DISTINCT
to return a count of distinct values
Definition SalesforceRestDataProviderDefs.qc.dox.h:72
SalesforceRestDataProvider::SOQL_COP_WEEK_IN_MONTH
const SOQL_COP_WEEK_IN_MONTH
to return the week in the month of a date or date/time value
Definition SalesforceRestDataProviderDefs.qc.dox.h:142
SalesforceRestDataProvider::SOQL_COP_HOUR_IN_DAY
const SOQL_COP_HOUR_IN_DAY
to return the hextern in the day of a date/time value
Definition SalesforceRestDataProviderDefs.qc.dox.h:137
SalesforceRestDataProvider::SOQL_COP_WEEK_IN_YEAR
const SOQL_COP_WEEK_IN_YEAR
to return the week in the year of a date or date/time value
Definition SalesforceRestDataProviderDefs.qc.dox.h:147
SalesforceRestDataProvider::SOQL_COP_SUM
const SOQL_COP_SUM
to return the sum value
Definition SalesforceRestDataProviderDefs.qc.dox.h:62
SalesforceRestDataProvider::SOQL_COP_DAY_ONLY
const SOQL_COP_DAY_ONLY
to return the date from a date/time value
Definition SalesforceRestDataProviderDefs.qc.dox.h:117
SalesforceRestDataProvider::SOQL_COP_DAY_IN_MONTH
const SOQL_COP_DAY_IN_MONTH
to return the day in a month of a date or date/time value
Definition SalesforceRestDataProviderDefs.qc.dox.h:102
SalesforceRestDataProvider::soql_op_gt
hash< SoqlOperatorInfo > soql_op_gt(auto arg)
returns an SoqlOperatorInfo hash for the ">" operator with the given argument for use in salesforce w...
SalesforceRestDataProvider::soql_op_not_in
hash< SoqlOperatorInfo > soql_op_not_in()
returns an SoqlOperatorInfo hash for the "not in" operator with all arguments passed to the function;...
SalesforceRestDataProvider::soql_wop_or
hash< string, hash< SoqlOperatorInfo > > soql_wop_or(hash< auto > h1, hash< auto > h2)
returns an SoqlOperatorInfo hash with a fake "_OR_" column name; the list of arguments to the functio...
SalesforceRestDataProvider::soql_op_like
hash< SoqlOperatorInfo > soql_op_like(string str)
returns an SoqlOperatorInfo hash for the "like" operator with the given argument for use in salesforc...
SalesforceRestDataProvider::soql_op_lt
hash< SoqlOperatorInfo > soql_op_lt(auto arg)
returns an SoqlOperatorInfo hash for the "<" operator with the given argument for use in salesforce w...
SalesforceRestDataProvider::soql_op_ne
hash< SoqlOperatorInfo > soql_op_ne(auto arg)
returns an SoqlOperatorInfo hash for the "!=" or "<>" operator with the given argument for use in sal...
SalesforceRestDataProvider::soql_make_op
hash< SoqlOperatorInfo > soql_make_op(string op, auto arg)
SalesforceRestDataProvider::soql_op_ge
hash< SoqlOperatorInfo > soql_op_ge(auto arg)
returns an SoqlOperatorInfo hash for the ">=" operator with the given argument for use in salesforce ...
SalesforceRestDataProvider::soql_op_not
hash< SoqlOperatorInfo > soql_op_not(hash arg)
returns an SoqlOperatorInfo hash for the "not" operator; for use in salesforce where clauses
SalesforceRestDataProvider::soql_op_in
hash< SoqlOperatorInfo > soql_op_in()
returns an SoqlOperatorInfo hash for the "in" operator with all arguments passed to the function; for...
SalesforceRestDataProvider::soql_op_le
hash< SoqlOperatorInfo > soql_op_le(auto arg)
returns an SoqlOperatorInfo hash for the "<=" operator with the given argument for use in salesforce ...
SalesforceRestDataProvider::soql_op_eq
hash< SoqlOperatorInfo > soql_op_eq(auto arg)
returns an SoqlOperatorInfo hash for the "=" operator with the given argument for use in salesforce w...
SalesforceRestDataProvider::SOQL_OP_GE
const SOQL_OP_GE
the SOQL greater than or equals operator (>=) for use in where clauses
Definition SalesforceRestDataProviderDefs.qc.dox.h:189
SalesforceRestDataProvider::SOQL_OP_NOT_IN
const SOQL_OP_NOT_IN
the SOQL in operator for use in where clauses
Definition SalesforceRestDataProviderDefs.qc.dox.h:169
SalesforceRestDataProvider::SOQL_OP_EQ
const SOQL_OP_EQ
the SOQL equals operator (=) for use in where clauses
Definition SalesforceRestDataProviderDefs.qc.dox.h:199
SalesforceRestDataProvider::SOQL_OP_NE
const SOQL_OP_NE
the SOQL not equals operator (!= or <>) for use in where clauses
Definition SalesforceRestDataProviderDefs.qc.dox.h:194
SalesforceRestDataProvider::SOQL_OP_IN
const SOQL_OP_IN
the SOQL in operator for use in where clauses
Definition SalesforceRestDataProviderDefs.qc.dox.h:164
SalesforceRestDataProvider::SOQL_OP_NOT
const SOQL_OP_NOT
the SOQL "not" operator for use in where clauses
Definition SalesforceRestDataProviderDefs.qc.dox.h:204
SalesforceRestDataProvider::SOQL_OP_LT
const SOQL_OP_LT
the SOQL less than (<) operator for use in where clauses
Definition SalesforceRestDataProviderDefs.qc.dox.h:174
SalesforceRestDataProvider::SOQL_OP_LIKE
const SOQL_OP_LIKE
Definition SalesforceRestDataProviderDefs.qc.dox.h:159
SalesforceRestDataProvider::SOQL_OP_GT
const SOQL_OP_GT
the SOQL greater than operator (>) for use in where clauses
Definition SalesforceRestDataProviderDefs.qc.dox.h:184
SalesforceRestDataProvider::SOQL_OP_OR
const SOQL_OP_OR
to combine SOQL expressions with "or" for use in where clauses
Definition SalesforceRestDataProviderDefs.qc.dox.h:209
SalesforceRestDataProvider::SOQL_OP_LE
const SOQL_OP_LE
the SOQL less than or equals (<=) operator for use in where clauses
Definition SalesforceRestDataProviderDefs.qc.dox.h:179
SalesforceRestDataProvider::soql_cop_fiscal_year
hash< SoqlColumnOperatorInfo > soql_cop_fiscal_year(auto column)
returns a SoqlColumnOperatorInfo hash for the "fiscal_year" function; returns the fiscal year for a d...
SalesforceRestDataProvider::soql_cop_calendar_year
hash< SoqlColumnOperatorInfo > soql_cop_calendar_year(auto column)
returns a SoqlColumnOperatorInfo hash for the "calendar_year" function; returns the calendar year for...
SalesforceRestDataProvider::soql_cop_fiscal_quarter
hash< SoqlColumnOperatorInfo > soql_cop_fiscal_quarter(auto column)
returns a SoqlColumnOperatorInfo hash for the "fiscal_quarter" function; returns the fiscal quarter f...
SalesforceRestDataProvider::soql_cop_count
hash< SoqlColumnOperatorInfo > soql_cop_count(auto column='')
returns a SoqlColumnOperatorInfo hash for the "count" aggregate function; returns row counts
SalesforceRestDataProvider::soql_cop_day_only
hash< SoqlColumnOperatorInfo > soql_cop_day_only(auto column)
returns a SoqlColumnOperatorInfo hash for the "day_only" function; returns the date from a date/time ...
SalesforceRestDataProvider::soql_cop_calendar_quarter
hash< SoqlColumnOperatorInfo > soql_cop_calendar_quarter(auto column)
returns a SoqlColumnOperatorInfo hash for the "calendar_quarter" function; returns the calendar quart...
SalesforceRestDataProvider::soql_cop_convert_currency
hash< SoqlColumnOperatorInfo > soql_cop_convert_currency(auto column)
returns a SoqlColumnOperatorInfo hash for the "convertCurrency" operator; returns the given column va...
SalesforceRestDataProvider::soql_cop_hour_in_day
hash< SoqlColumnOperatorInfo > soql_cop_hour_in_day(auto column)
returns a SoqlColumnOperatorInfo hash for the "hour_in_day" function; returns the hextern in the day ...
SalesforceRestDataProvider::soql_cop_day_in_year
hash< SoqlColumnOperatorInfo > soql_cop_day_in_year(auto column)
returns a SoqlColumnOperatorInfo hash for the "day_in_year" function; returns the day in the year for...
SalesforceRestDataProvider::soql_make_cop
hash< SoqlColumnOperatorInfo > soql_make_cop(string cop, auto column, auto arg)
SalesforceRestDataProvider::soql_cop_avg
hash< SoqlColumnOperatorInfo > soql_cop_avg(auto column)
returns a SoqlColumnOperatorInfo hash for the "avg" operator; returns average column values
SalesforceRestDataProvider::soql_cop_fiscal_month
hash< SoqlColumnOperatorInfo > soql_cop_fiscal_month(auto column)
returns a SoqlColumnOperatorInfo hash for the "fiscal_month" function; returns the fiscal month for a...
SalesforceRestDataProvider::soql_cop_count_distinct
hash< SoqlColumnOperatorInfo > soql_cop_count_distinct(auto column='')
returns a SoqlColumnOperatorInfo hash for the "count_distinct" aggregate function; returns row counts
SalesforceRestDataProvider::soql_cop_format
hash< SoqlColumnOperatorInfo > soql_cop_format(auto column)
returns a SoqlColumnOperatorInfo hash for the "format" operator; returns the given column value in th...
SalesforceRestDataProvider::soql_cop_week_in_year
hash< SoqlColumnOperatorInfo > soql_cop_week_in_year(auto column)
returns a SoqlColumnOperatorInfo hash for the "week_in_m=year" function; returns the week in the year...
SalesforceRestDataProvider::soql_cop_day_in_month
hash< SoqlColumnOperatorInfo > soql_cop_day_in_month(auto column)
returns a SoqlColumnOperatorInfo hash for the "day_in_month" function; returns the day in the month f...
SalesforceRestDataProvider::soql_cop_week_in_month
hash< SoqlColumnOperatorInfo > soql_cop_week_in_month(auto column)
returns a SoqlColumnOperatorInfo hash for the "week_in_month" function; returns the week in the month...
SalesforceRestDataProvider::soql_cop_calendar_month
hash< SoqlColumnOperatorInfo > soql_cop_calendar_month(auto column)
returns a SoqlColumnOperatorInfo hash for the "calendar_month" function; returns the calendar month f...
SalesforceRestDataProvider::soql_cop_min
hash< SoqlColumnOperatorInfo > soql_cop_min(auto column)
returns a SoqlColumnOperatorInfo hash for the "min" operator; returns minimum column values
SalesforceRestDataProvider::soql_cop_sum
hash< SoqlColumnOperatorInfo > soql_cop_sum(auto column)
returns a SoqlColumnOperatorInfo hash for the "sum" operator; returns the total sum of a numeric colu...
SalesforceRestDataProvider::soql_cop_day_in_week
hash< SoqlColumnOperatorInfo > soql_cop_day_in_week(auto column)
returns a SoqlColumnOperatorInfo hash for the "day_in_week" function; returns the day in the week for...
SalesforceRestDataProvider::soql_cop_max
hash< SoqlColumnOperatorInfo > soql_cop_max(auto column)
returns a SoqlColumnOperatorInfo hash for the "max" operator; returns maximum column values
SalesforceRestDataProvider
Qore SalesforceRestDataProvider module definition.
Definition SalesforceRestDataProvider.qc.dox.h:26
SalesforceRestDataProvider::DefaultSoqlOpMap
const DefaultSoqlOpMap
a hash of valid operators for use in where clauses
Definition SalesforceRestDataProviderDefs.qc.dox.h:718
SalesforceRestDataProvider::SoqlColumnOperatorInfo
column operator info hash as returned by all column operator functions
Definition SalesforceRestDataProviderDefs.qc.dox.h:34
SalesforceRestDataProvider::SoqlColumnOperatorInfo::arg
auto arg
optional argument
Definition SalesforceRestDataProviderDefs.qc.dox.h:37
SalesforceRestDataProvider::SoqlColumnOperatorInfo::column
auto column
column sopecifier, may be a string or a complex hash
Definition SalesforceRestDataProviderDefs.qc.dox.h:36
SalesforceRestDataProvider::SoqlColumnOperatorInfo::cop
string cop
the column operator string code
Definition SalesforceRestDataProviderDefs.qc.dox.h:35
SalesforceRestDataProvider::SoqlOperatorInfo
SOQL operator info hash as returned by all operator functions.
Definition SalesforceRestDataProviderDefs.qc.dox.h:28
SalesforceRestDataProvider::SoqlOperatorInfo::arg
auto arg
optional argument
Definition SalesforceRestDataProviderDefs.qc.dox.h:30
SalesforceRestDataProvider::SoqlOperatorInfo::op
string op
the operator string code
Definition SalesforceRestDataProviderDefs.qc.dox.h:29