Qore SalesforceRestDataProvider Module Reference  1.0.1
SalesforceRestDataProviderDefs.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
25 // minimum required Qore version
26 // assume local scope for variables, do not use "$" signs
27 // require type definitions everywhere
29 // enable all warnings
30 
34 public struct SoqlOperatorInfo {
35  string op;
36  auto arg;
37 };
38 
40 public struct SoqlColumnOperatorInfo {
41  string cop;
42  auto column;
43  auto arg;
44 };
45 
50 
53 const SOQL_COP_MIN = "min";
54 
56 
58 const SOQL_COP_MAX = "max";
59 
61 
63 const SOQL_COP_AVG = "avg";
64 
66 
68 const SOQL_COP_SUM = "sum";
69 
71 
73 const SOQL_COP_COUNT = "count";
74 
76 
78 const SOQL_COP_COUNT_DISTINCT = "count_distinct";
79 
81 
83 const SOQL_COP_FORMAT = "format";
84 
86 
88 const SOQL_COP_CONVERT_CURRENCY = "convert_currency";
89 
91 
93 const SOQL_COP_CALENDAR_MONTH = "calendar_month";
94 
96 
98 const SOQL_COP_CALENDAR_QUARTER = "calendar_quarter";
99 
101 
103 const SOQL_COP_CALENDAR_YEAR = "calendar_year";
104 
106 
108 const SOQL_COP_DAY_IN_MONTH = "day_in_month";
109 
111 
113 const SOQL_COP_DAY_IN_WEEK = "day_in_week";
114 
116 
118 const SOQL_COP_DAY_IN_YEAR = "day_in_year";
119 
121 
123 const SOQL_COP_DAY_ONLY = "day_only";
124 
126 
128 const SOQL_COP_FISCAL_MONTH = "fiscal_month";
129 
131 
133 const SOQL_COP_FISCAL_QUARTER = "fiscal_quarter";
134 
136 
138 const SOQL_COP_FISCAL_YEAR = "fiscal_year";
139 
141 
143 const SOQL_COP_HOUR_IN_DAY = "hour_in_day";
144 
146 
148 const SOQL_COP_WEEK_IN_MONTH = "week_in_month";
149 
151 
153 const SOQL_COP_WEEK_IN_YEAR = "week_in_year";
154 
156 const DefaultSoqlCopMap = ...;
157 
159 
164 const SOQL_OP_LIKE = "like";
166 
168 
170 const SOQL_OP_IN = "in";
171 
173 
175 const SOQL_OP_NOT_IN = "not in";
176 
178 
180 const SOQL_OP_LT = "<";
181 
183 
185 const SOQL_OP_LE = "<=";
186 
188 
190 const SOQL_OP_GT = ">";
191 
193 
195 const SOQL_OP_GE = ">=";
196 
198 
200 const SOQL_OP_NE = "!=";
201 
203 
205 const SOQL_OP_EQ = "=";
206 
208 
210 const SOQL_OP_NOT = "not";
211 
213 
215 const SOQL_OP_OR = "or";
217 
243 
253  hash<SoqlColumnOperatorInfo> soql_make_cop(string cop, auto column, auto arg);
254 
255 
257 
267  hash<SoqlColumnOperatorInfo> soql_cop_min(auto column);
268 
269 
271 
281  hash<SoqlColumnOperatorInfo> soql_cop_max(auto column);
282 
283 
285 
295  hash<SoqlColumnOperatorInfo> soql_cop_avg(auto column);
296 
297 
299 
309  hash<SoqlColumnOperatorInfo> soql_cop_sum(auto column);
310 
311 
313 
321  hash<SoqlColumnOperatorInfo> soql_cop_count(auto column = '');
322 
323 
325 
333  hash<SoqlColumnOperatorInfo> soql_cop_count_distinct(auto column = '');
334 
335 
337 
350  hash<SoqlColumnOperatorInfo> soql_cop_format(auto column);
351 
352 
354 
364  hash<SoqlColumnOperatorInfo> soql_cop_convert_currency(auto column);
365 
366 
368 
376  hash<SoqlColumnOperatorInfo> soql_cop_calendar_month(auto column);
377 
378 
380 
388  hash<SoqlColumnOperatorInfo> soql_cop_calendar_quarter(auto column);
389 
390 
392 
400  hash<SoqlColumnOperatorInfo> soql_cop_calendar_year(auto column);
401 
402 
404 
412  hash<SoqlColumnOperatorInfo> soql_cop_day_in_month(auto column);
413 
414 
416 
424  hash<SoqlColumnOperatorInfo> soql_cop_day_in_week(auto column);
425 
426 
428 
436  hash<SoqlColumnOperatorInfo> soql_cop_day_in_year(auto column);
437 
438 
440 
448  hash<SoqlColumnOperatorInfo> soql_cop_day_only(auto column);
449 
450 
452 
460  hash<SoqlColumnOperatorInfo> soql_cop_fiscal_month(auto column);
461 
462 
464 
472  hash<SoqlColumnOperatorInfo> soql_cop_fiscal_quarter(auto column);
473 
474 
476 
484  hash<SoqlColumnOperatorInfo> soql_cop_fiscal_year(auto column);
485 
486 
488 
496  hash<SoqlColumnOperatorInfo> soql_cop_hour_in_day(auto column);
497 
498 
500 
508  hash<SoqlColumnOperatorInfo> soql_cop_week_in_month(auto column);
509 
510 
512 
520  hash<SoqlColumnOperatorInfo> soql_cop_week_in_year(auto column);
522 
538  hash<SoqlOperatorInfo> soql_make_op(string op, auto arg);
540 
541 
543 
552  hash<SoqlOperatorInfo> soql_op_like(string str);
553 
554 
556 
565  hash<SoqlOperatorInfo> soql_op_lt(auto arg);
566 
567 
569 
578  hash<SoqlOperatorInfo> soql_op_le(auto arg);
579 
580 
582 
591  hash<SoqlOperatorInfo> soql_op_gt(auto arg);
592 
593 
595 
604  hash<SoqlOperatorInfo> soql_op_ge(auto arg);
605 
606 
608 
615  hash<SoqlOperatorInfo> soql_op_ne(auto arg);
616 
617 
619 
628  hash<SoqlOperatorInfo> soql_op_eq(auto arg);
629 
630 
632 
641  hash<SoqlOperatorInfo> soql_op_in();
642 
643 
645 
656  hash<SoqlOperatorInfo> soql_op_in(list<auto> args);
657 
658 
660 
669  hash<SoqlOperatorInfo> soql_op_not_in();
670 
671 
673 
684  hash<SoqlOperatorInfo> soql_op_not_in(list<auto> args);
685 
686 
688 
695  hash<SoqlOperatorInfo> soql_op_not(hash arg);
696 
697 
699 
718  hash<string, hash<SoqlOperatorInfo>> soql_wop_or(hash<auto> h1, hash<auto> h2);
719 
721 
723 const DefaultSoqlOpMap = ...;
724 
726 };
auto arg
optional argument
Definition: SalesforceRestDataProviderDefs.qc.dox.h:43
const SOQL_OP_IN
the SOQL in operator for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:170
hash< SoqlColumnOperatorInfo > soql_cop_sum(auto column)
returns a SoqlColumnOperatorInfo hash for the "sum" operator; returns the total sum of a numeric colu...
const SOQL_COP_CALENDAR_YEAR
to return the calendar year of a date or date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:103
hash< SoqlOperatorInfo > soql_op_le(auto arg)
returns an SoqlOperatorInfo hash for the "<=" operator with the given argument for use in salesforce ...
const SOQL_OP_EQ
the SOQL equals operator (=) for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:205
const SOQL_COP_FISCAL_MONTH
to return the fiscal month of a date or date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:128
hash< SoqlOperatorInfo > soql_op_ne(auto arg)
returns an SoqlOperatorInfo hash for the "!=" or "<>" operator with the given argument for use in sal...
hash< SoqlColumnOperatorInfo > soql_cop_calendar_quarter(auto column)
returns a SoqlColumnOperatorInfo hash for the "calendar_quarter" function; returns the calendar quart...
Qore SalesforceRestDataProvider module definition.
Definition: SalesforceRestDataProvider.qc.dox.h:32
hash< SoqlColumnOperatorInfo > soql_cop_max(auto column)
returns a SoqlColumnOperatorInfo hash for the "max" operator; returns maximum column values ...
auto column
column sopecifier, may be a string or a complex hash
Definition: SalesforceRestDataProviderDefs.qc.dox.h:42
const SOQL_COP_CONVERT_CURRENCY
to return the given column value in the default currency for the calling user
Definition: SalesforceRestDataProviderDefs.qc.dox.h:88
hash< SoqlColumnOperatorInfo > soql_cop_fiscal_month(auto column)
returns a SoqlColumnOperatorInfo hash for the "fiscal_month" function; returns the fiscal month for a...
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...
hash< SoqlOperatorInfo > soql_op_in()
returns an SoqlOperatorInfo hash for the "in" operator with all arguments passed to the function; for...
hash< SoqlOperatorInfo > soql_op_not_in()
returns an SoqlOperatorInfo hash for the "not in" operator with all arguments passed to the function;...
hash< SoqlColumnOperatorInfo > soql_cop_fiscal_quarter(auto column)
returns a SoqlColumnOperatorInfo hash for the "fiscal_quarter" function; returns the fiscal quarter f...
SOQL operator info hash as returned by all operator functions.
Definition: SalesforceRestDataProviderDefs.qc.dox.h:34
const SOQL_OP_LT
the SOQL less than (<) operator for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:180
hash< SoqlColumnOperatorInfo > soql_cop_calendar_month(auto column)
returns a SoqlColumnOperatorInfo hash for the "calendar_month" function; returns the calendar month f...
hash< SoqlOperatorInfo > soql_op_eq(auto arg)
returns an SoqlOperatorInfo hash for the "=" operator with the given argument for use in salesforce w...
hash< SoqlColumnOperatorInfo > soql_cop_convert_currency(auto column)
returns a SoqlColumnOperatorInfo hash for the "convertCurrency" operator; returns the given column va...
hash< SoqlColumnOperatorInfo > soql_cop_count_distinct(auto column='')
returns a SoqlColumnOperatorInfo hash for the "count_distinct" aggregate function; returns row counts...
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:118
const SOQL_COP_MAX
to return the maximum value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:58
string cop
the column operator string code
Definition: SalesforceRestDataProviderDefs.qc.dox.h:41
const DefaultSoqlOpMap
a hash of valid operators for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:723
const SOQL_COP_DAY_ONLY
to return the date from a date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:123
const SOQL_OP_OR
to combine SOQL expressions with "or" for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:215
const SOQL_COP_FISCAL_YEAR
to return the fiscal year of a date or date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:138
hash< SoqlOperatorInfo > soql_op_not(hash arg)
returns an SoqlOperatorInfo hash for the "not" operator; for use in salesforce where clauses ...
auto arg
optional argument
Definition: SalesforceRestDataProviderDefs.qc.dox.h:36
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:108
column operator info hash as returned by all column operator functions
Definition: SalesforceRestDataProviderDefs.qc.dox.h:40
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:148
hash< SoqlColumnOperatorInfo > soql_cop_fiscal_year(auto column)
returns a SoqlColumnOperatorInfo hash for the "fiscal_year" function; returns the fiscal year for a d...
hash< SoqlOperatorInfo > soql_op_ge(auto arg)
returns an SoqlOperatorInfo hash for the ">=" operator with the given argument for use in salesforce ...
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:83
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 ...
const SOQL_COP_CALENDAR_MONTH
to return the calendar month of a date or date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:93
const SOQL_OP_NOT_IN
the SOQL in operator for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:175
const SOQL_OP_LIKE
like operator
Definition: SalesforceRestDataProviderDefs.qc.dox.h:165
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:113
hash< SoqlColumnOperatorInfo > soql_make_cop(string cop, auto column, auto arg)
returns a SoqlColumnOperatorInfo hash
hash< SoqlColumnOperatorInfo > soql_cop_avg(auto column)
returns a SoqlColumnOperatorInfo hash for the "avg" operator; returns average column values ...
hash< SoqlOperatorInfo > soql_make_op(string op, auto arg)
returns an SoqlOperatorInfo hash
hash< SoqlColumnOperatorInfo > soql_cop_min(auto column)
returns a SoqlColumnOperatorInfo hash for the "min" operator; returns minimum column values ...
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...
const SOQL_COP_AVG
to return the average value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:63
hash< SoqlColumnOperatorInfo > soql_cop_count(auto column='')
returns a SoqlColumnOperatorInfo hash for the "count" aggregate function; returns row counts ...
const SOQL_COP_CALENDAR_QUARTER
to return the calendar quarter of a date or date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:98
hash< auto > hash(object obj)
const SOQL_OP_LE
the SOQL less than or equals (<=) operator for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:185
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...
const SOQL_OP_GE
the SOQL greater than or equals operator (>=) for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:195
const SOQL_COP_HOUR_IN_DAY
to return the hextern in the day of a date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:143
const SOQL_COP_COUNT_DISTINCT
to return a count of distinct values
Definition: SalesforceRestDataProviderDefs.qc.dox.h:78
const SOQL_OP_NE
the SOQL not equals operator (!= or <>) for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:200
const SOQL_COP_COUNT
to return the row count
Definition: SalesforceRestDataProviderDefs.qc.dox.h:73
const SOQL_OP_GT
the SOQL greater than operator (>) for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:190
hash< SoqlColumnOperatorInfo > soql_cop_format(auto column)
returns a SoqlColumnOperatorInfo hash for the "format" operator; returns the given column value in th...
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...
const SOQL_COP_SUM
to return the sum value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:68
const SOQL_COP_MIN
to return the minimum value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:53
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...
hash< SoqlOperatorInfo > soql_op_like(string str)
returns an SoqlOperatorInfo hash for the "like" operator with the given argument for use in salesforc...
hash< SoqlColumnOperatorInfo > soql_cop_day_only(auto column)
returns a SoqlColumnOperatorInfo hash for the "day_only" function; returns the date from a date/time ...
string op
the operator string code
Definition: SalesforceRestDataProviderDefs.qc.dox.h:35
const DefaultSoqlCopMap
a hash of default column operator descriptions
Definition: SalesforceRestDataProviderDefs.qc.dox.h:156
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...
hash< SoqlColumnOperatorInfo > soql_cop_calendar_year(auto column)
returns a SoqlColumnOperatorInfo hash for the "calendar_year" function; returns the calendar year for...
hash< SoqlOperatorInfo > soql_op_lt(auto arg)
returns an SoqlOperatorInfo hash for the "<" operator with the given argument for use in salesforce w...
const SOQL_COP_FISCAL_QUARTER
to return the fiscal quarter of a date or date/time value
Definition: SalesforceRestDataProviderDefs.qc.dox.h:133
const SOQL_OP_NOT
the SOQL "not" operator for use in where clauses
Definition: SalesforceRestDataProviderDefs.qc.dox.h:210
hash< SoqlOperatorInfo > soql_op_gt(auto arg)
returns an SoqlOperatorInfo hash for the ">" operator with the given argument for use in salesforce w...
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:153