| Qore SalesforceRestDataProvider Module Reference 2.0

Loading...
Searching...
No Matches
Classes | Functions | Variables
SalesforceRestDataProvider Namespace Reference

Qore SalesforceRestDataProvider module definition. More...

## Classes
class | SalesforceRestDataProvider
| The SalesforceRest data provider class. More...
class | SalesforceRestDataProviderBase
| The SalesforceRest data provider class. More...
class | SalesforceRestDataProviderFactory
| The SalesforceRest data provider factory. More...
class | SalesforceRestObjectDataProvider
| The SalesforceRestObjectDataProvider data provider class. More...
class | SalesforceRestRecordIterator
| Defines the record iterator class for Table-based iterators. More...
class | SalesforceRestTablesDataProvider
| The SalesforceRest data provider class. More...
struct | SoqlColumnOperatorInfo
| column operator info hash as returned by all column operator functions More...
struct | SoqlOperatorInfo
| SOQL operator info hash as returned by all operator functions. More...

## Functions
hash< SoqlColumnOperatorInfo > | soql_cop_avg (auto column)
| returns a SoqlColumnOperatorInfo hash for the `"avg"` operator; returns average column values
hash< SoqlColumnOperatorInfo > | soql_cop_calendar_month (auto column)
| returns a SoqlColumnOperatorInfo hash for the `"calendar_month"` function; returns the calendar month for a date or date/time value
hash< SoqlColumnOperatorInfo > | soql_cop_calendar_quarter (auto column)
| returns a SoqlColumnOperatorInfo hash for the `"calendar_quarter"` function; returns the calendar quarter for a date or date/time value
hash< SoqlColumnOperatorInfo > | soql_cop_calendar_year (auto column)
| returns a SoqlColumnOperatorInfo hash for the `"calendar_year"` function; returns the calendar year for a date or date/time value
hash< SoqlColumnOperatorInfo > | soql_cop_convert_currency (auto column)
| returns a SoqlColumnOperatorInfo hash for the `"convertCurrency"` operator; returns the given column value in the default currency for the current user
hash< SoqlColumnOperatorInfo > | soql_cop_count (auto column='')
| returns a SoqlColumnOperatorInfo hash for the `"count"` aggregate function; returns row counts
hash< SoqlColumnOperatorInfo > | soql_cop_count_distinct (auto column='')
| returns a SoqlColumnOperatorInfo hash for the `"count_distinct"` aggregate function; returns row counts
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 for a date or date/time value
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 a date or date/time value (1 = Sunday, 7 = Saturday)
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 a date or date/time value
hash< SoqlColumnOperatorInfo > | soql_cop_day_only (auto column)
| returns a SoqlColumnOperatorInfo hash for the `"day_only"` function; returns the date from a date/time value
hash< SoqlColumnOperatorInfo > | soql_cop_fiscal_month (auto column)
| returns a SoqlColumnOperatorInfo hash for the `"fiscal_month"` function; returns the fiscal month for a date or date/time value
hash< SoqlColumnOperatorInfo > | soql_cop_fiscal_quarter (auto column)
| returns a SoqlColumnOperatorInfo hash for the `"fiscal_quarter"` function; returns the fiscal quarter for a date or date/time value
hash< SoqlColumnOperatorInfo > | soql_cop_fiscal_year (auto column)
| returns a SoqlColumnOperatorInfo hash for the `"fiscal_year"` function; returns the fiscal year for a date or date/time value
hash< SoqlColumnOperatorInfo > | soql_cop_format (auto column)
| returns a SoqlColumnOperatorInfo hash for the `"format"` operator; returns the given column value in the default locale for number, date, time, and currency fields
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 for a date/time value
hash< SoqlColumnOperatorInfo > | soql_cop_max (auto column)
| returns a SoqlColumnOperatorInfo hash for the `"max"` operator; returns maximum column values
hash< SoqlColumnOperatorInfo > | soql_cop_min (auto column)
| returns a SoqlColumnOperatorInfo hash for the `"min"` operator; returns minimum column values
hash< SoqlColumnOperatorInfo > | soql_cop_sum (auto column)
| returns a SoqlColumnOperatorInfo hash for the `"sum"` operator; returns the total sum of a numeric column.
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 for a date or date/time value
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 for a date or date/time value
hash< SoqlColumnOperatorInfo > | soql_make_cop (string cop, auto column, auto arg)
hash< SoqlOperatorInfo > | soql_make_op (string op, auto arg)
hash< SoqlOperatorInfo > | soql_op_eq (auto arg)
| returns an SoqlOperatorInfo hash for the `"="` operator with the given argument for use in salesforce where clauses when comparing column values to immediate values
hash< SoqlOperatorInfo > | soql_op_ge (auto arg)
| returns an SoqlOperatorInfo hash for the `">="` operator with the given argument for use in salesforce where clauses when comparing column values to immediate values
hash< SoqlOperatorInfo > | soql_op_gt (auto arg)
| returns an SoqlOperatorInfo hash for the `">"` operator with the given argument for use in salesforce where clauses when comparing column values to immediate values
hash< SoqlOperatorInfo > | soql_op_in ()
| returns an SoqlOperatorInfo hash for the `"in"` operator with all arguments passed to the function; for use in salesforce where clauses
hash< SoqlOperatorInfo > | soql_op_in (list< auto > args)
| returns an SoqlOperatorInfo hash for the `"in"` operator with the given argument list as the first argument; for use in salesforce where clauses
hash< SoqlOperatorInfo > | soql_op_le (auto arg)
| returns an SoqlOperatorInfo hash for the `"<="` operator with the given argument for use in salesforce where clauses when comparing column values to immediate values
hash< SoqlOperatorInfo > | soql_op_like (string str)
| returns an SoqlOperatorInfo hash for the `"like"` operator with the given argument for use in salesforce where clauses
hash< SoqlOperatorInfo > | soql_op_lt (auto arg)
| returns an SoqlOperatorInfo hash for the `"<"` operator with the given argument for use in salesforce where clauses when comparing column values to immediate values
hash< SoqlOperatorInfo > | soql_op_ne (auto arg)
| returns an SoqlOperatorInfo hash for the `"!="` or `"<>"` operator with the given argument for use in salesforce where clauses when comparing column values to immediate values
hash< SoqlOperatorInfo > | soql_op_not (hash arg)
| returns an SoqlOperatorInfo hash for the `"not"` operator; for use in salesforce where clauses
hash< SoqlOperatorInfo > | soql_op_not_in ()
| returns an SoqlOperatorInfo hash for the `"not in"` operator with all arguments passed to the function; for use in salesforce where clauses
hash< SoqlOperatorInfo > | soql_op_not_in (list< auto > args)
| returns an SoqlOperatorInfo hash for the `"not in"` operator with the given argument list as the first argument; for use in salesforce where clauses
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 function is combined such that each hash in the list generates SQL expressions combined with "and" logic, and each of those clauses is combined with "or" logic; this is for use in salesforce where clauses

## Variables
const | AppName = "Salesforce"
| Application name.
hash< string, bool > | date_fields
| Hash of date fields for this record.
hash< string, bool > | date_time_fields
| Hash of date/time fields for this record.
hash< string, bool > | defaulted_on_create
| Fields that get a default value on create.
const | DefaultSoqlCopMap = ...
| a hash of default column operator descriptions
const | DefaultSoqlOpMap = ...
| a hash of valid operators for use in where clauses
hash< string, string > | field_types
| The original field type names.
hash< string, bool > | no_create
| Fields that cannot be included when creating records.
hash< string, bool > | no_update
| Fields that cannot be included when updating records.
hashdecl | SalesforceRestRecordInfo
| contains Salesforce object record information
const | SOQL_COP_AVG = "avg"
| to return the average value
const | SOQL_COP_CALENDAR_MONTH = "calendar_month"
| to return the calendar month of a date or date/time value
const | SOQL_COP_CALENDAR_QUARTER = "calendar_quarter"
| to return the calendar quarter of a date or date/time value
const | SOQL_COP_CALENDAR_YEAR = "calendar_year"
| to return the calendar year of a date or date/time value
const | SOQL_COP_CONVERT_CURRENCY = "convert_currency"
| to return the given column value in the default currency for the calling user
const | SOQL_COP_COUNT = "count"
| to return the row count
const | SOQL_COP_COUNT_DISTINCT = "count_distinct"
| to return a count of distinct values
const | SOQL_COP_DAY_IN_MONTH = "day_in_month"
| to return the day in a month of a date or date/time value
const | SOQL_COP_DAY_IN_WEEK = "day_in_week"
| to return the day in the week of a date or date/time value (1 = Sunday, 7 = Saturday)
const | SOQL_COP_DAY_IN_YEAR = "day_in_year"
| to return the day in the year of a date or date/time value
const | SOQL_COP_DAY_ONLY = "day_only"
| to return the date from a date/time value
const | SOQL_COP_FISCAL_MONTH = "fiscal_month"
| to return the fiscal month of a date or date/time value
const | SOQL_COP_FISCAL_QUARTER = "fiscal_quarter"
| to return the fiscal quarter of a date or date/time value
const | SOQL_COP_FISCAL_YEAR = "fiscal_year"
| to return the fiscal year of a date or date/time value
const | SOQL_COP_FORMAT = "format"
| to return the given column value in the default locale for number, date, time, and currency fields
const | SOQL_COP_HOUR_IN_DAY = "hour_in_day"
| to return the hextern in the day of a date/time value
const | SOQL_COP_MAX = "max"
| to return the maximum value
const | SOQL_COP_MIN = "min"
const | SOQL_COP_SUM = "sum"
| to return the sum value
const | SOQL_COP_WEEK_IN_MONTH = "week_in_month"
| to return the week in the month of a date or date/time value
const | SOQL_COP_WEEK_IN_YEAR = "week_in_year"
| to return the week in the year of a date or date/time value
const | SOQL_OP_EQ = "="
| the SOQL equals operator (=) for use in where clauses
const | SOQL_OP_GE = ">="
| the SOQL greater than or equals operator (>=) for use in where clauses
const | SOQL_OP_GT = ">"
| the SOQL greater than operator (>) for use in where clauses
const | SOQL_OP_IN = "in"
| the SOQL in operator for use in where clauses
const | SOQL_OP_LE = "<="
| the SOQL less than or equals (<=) operator for use in where clauses
const | SOQL_OP_LIKE = "like"
const | SOQL_OP_LT = "<"
| the SOQL less than (<) operator for use in where clauses
const | SOQL_OP_NE = "!="
| the SOQL not equals operator (!= or <>) for use in where clauses
const | SOQL_OP_NOT = "not"
| the SOQL `"not"` operator for use in where clauses
const | SOQL_OP_NOT_IN = "not in"
| the SOQL in operator for use in where clauses
const | SOQL_OP_OR = "or"
| to combine SOQL expressions with `"or"` for use in where clauses
hash< string, bool > | time_fields
| Hash of time fields for this record.

## Detailed Description

Qore SalesforceRestDataProvider module definition.

Qore SalesforceRestTablesDataProvider module definition.

Qore SalesforceRestRecordIterator class definition.

Qore SalesforceRestDataProviderFactory class definition.

Qore SalesforceRestDataProviderDefs definitions.

contains all public definitions in the SalesforceRestDataProvider module

SalesforceRestDataProvider.qc Copyright 2023 - 2024 Qore Technologies, s.r.o.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. contains all public definitions in the SalesforceRestDataProvider module

SalesforceRestDataProviderBase.qc Copyright 2023 - 2024 Qore Technologies, s.r.o.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. contains all public definitions in the SalesforceRestDataProvider module

SalesforceRestDataProviderDefs.qc Copyright 2019 - 2024 Qore Technologies, s.r.o.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. contains all public definitions in the SalesforceRestDataProvider module

SalesforceRestDataProviderFactory.qc Copyright 2023 - 2024 Qore Technologies, s.r.o.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Contains all public definitions in the SalesforceRestDataProvider module

SalesforceRestObjectDataProvider.qc Copyright 2019 - 2024 Qore Technologies, s.r.o.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. contains all public definitions in the SalesforceRestDataProvider module

SalesforceRestRecordIterator.qc Copyright 2019 - 2024 Qore Technologies, s.r.o.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. contains all public definitions in the SalesforceRestDataProvider module

SalesforceRestTablesDataProvider.qc Copyright 2023 - 2024 Qore Technologies, s.r.o.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. contains all public definitions in the SalesforceRestDataProvider module