 |
Qore DataProvider Module Reference 3.6.0
|
|
Qore DataProvider Module Reference 3.6.0
|
The AbstractDataProvider class. More...
#include <AbstractDataProvider.qc.dox.h>
Public Member Methods | |
| *hash< string, hash< ActionOptionInfo > > | addCreateRecordOption (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Adds a record option to the given action options based on the given option data. | |
| void | addField (AbstractDataField field, *hash< auto > field_add_options) |
| Creates a new field. | |
| void | addFieldImpl (AbstractDataField field, *hash< auto > field_add_options) |
| Creates a new field. | |
| void | beginTransaction () |
| Begins a transaction with a data provider. | |
| void | checkAddField () |
| Ensures that the data provider supports adding fields. | |
| void | checkCreate () |
| Ensures that the data provider supports record creation. | |
| void | checkCreateChild () |
| Ensures that the data provider supports creating children. | |
| void | checkDelete () |
| Ensures that the data provider supports record deletion. | |
| void | checkDeleteChild () |
| Ensures that the data provider supports deleting children. | |
| void | checkDeleteField () |
| Ensures that the data provider supports deleting fields. | |
| void | checkMessages () |
| Ensures that the data provider supports sending messages. | |
| void | checkObservable () |
| Ensures that the data provider supports observer pattern / event API. | |
| void | checkRead () |
| Ensures that the data provider supports read operations. | |
| void | checkRequest () |
| Ensures that the data provider supports the request API. | |
| void | checkSchema () |
| Ensures that the data provider supports a schema. | |
| void | checkSearchExpressions () |
| Ensures that the data provider supports advanced search expressions. | |
| void | checkUpdate () |
| Ensures that the data provider supports record upserts. | |
| void | checkUpdateField () |
| Ensures that the data provider supports updating fields. | |
| void | checkUpsert () |
| Ensures that the data provider supports record upserts. | |
| bool | childrenIdentical () |
| Returns True if the data provider's children are all of the same class and all support the same options. | |
| void | collectDebugInfo (hash< DataProviderDebugInfo > info) |
| Collects debug info if a collector is registered. | |
| void | commit () |
| Commits data written to the data provider. | |
| void | constructor () |
| Creates the data provider. | |
| void | constructor (LoggerInterface logger) |
| Creates the data provider with the given Logger. | |
| AbstractDataProvider | createChildProvider (*hash< auto > child_create_options, string name, hash< string, AbstractDataField > fields) |
| Creates a new child data provider and returns it after adding as a child. | |
| AbstractDataProvider | createChildProviderImpl (*hash< auto > child_create_options, string name, hash< string, AbstractDataField > fields) |
| Creates a new child data provider and returns it after adding as a child. | |
| *hash< auto > | createRecord (hash< auto > rec, *hash< auto > create_options) |
| Creates the given record in the data provider. | |
| *hash< auto > | createRecordImpl (hash< auto > rec, *hash< auto > create_options) |
| Creates the given record in the data provider. | |
| *hash< auto > | createRecordsBulk (AbstractDataProviderBulkRecordInterface stream, *hash< auto > create_options) |
| Creates the given records in the data provider. | |
| *hash< auto > | createRecordsBulk (hash< auto > recs, *hash< auto > create_options) |
| Creates the given records in the data provider. | |
| *hash< auto > | createRecordsBulk (HashListIterator i, *hash< auto > create_options) |
| Creates the given records in the data provider. | |
| *hash< auto > | createRecordsBulk (list< auto > recs, *hash< auto > create_options) |
| Creates the given records in the data provider. | |
| *hash< auto > | createRecordsBulkImpl (hash< auto > recs, *hash< auto > create_options) |
| Creates the given records in the data provider. | |
| *hash< auto > | createRecordsBulkIntern (hash< auto > recs, *hash< auto > create_options) |
| Creates the given records in the data provider. | |
| *hash< auto > | createRecordsBulkWithOptions (*hash< auto > options) |
| Creates the given records in the data provider from create action options. | |
| *hash< auto > | createRecordWithOptions (*hash< auto > options) |
| Creates the given record in the data provider from create action options. | |
| bool | currentThreadInTransaction () |
| Returns True if the current thread is in a transaction. | |
| bool | currentThreadInTransactionImpl () |
| Returns True if the current thread is in a transaction. | |
| bool | debugCollectionEnabled () |
| Returns True if debug collection is enabled. | |
| void | deleteChildProvider (string name, *hash< auto > child_delete_options) |
| Deletes a child data provider. | |
| void | deleteChildProviderImpl (string name, *hash< auto > child_delete_options) |
| Deletes a child data provider. | |
| void | deleteField (string name, *hash< auto > field_delete_options) |
| Deletes an existing field. | |
| void | deleteFieldImpl (string name, *hash< auto > field_delete_options) |
| Deletes an existing field. | |
| int | deleteRecords (*hash< auto > where_cond, *hash< auto > search_options) |
| Deletes zero or more records. | |
| int | deleteRecords (*hash< DataProviderExpression > where_cond, *hash< auto > search_options) |
| Deletes zero or more records. | |
| int | deleteRecordsImpl (*hash< auto > where_cond, *hash< auto > search_options) |
| Deletes zero or more records. | |
| int | deleteRecordsWithOptions (*hash< auto > options) |
| Deletes zero or more records from delete action options. | |
| auto | doRequest (auto req, *hash< auto > request_options) |
| Makes a request and returns the response. | |
| auto | doRequestImpl (auto req, *hash< auto > request_options) |
| Makes a request and returns the response. | |
| hash< auto > | generateExampleData (hash< string, AbstractDataField > fields) |
| Generates example data for the given fields. | |
| *hash< auto > | getAdditionalInfo () |
| Returns additional provider-specific information. | |
| AbstractDataProviderBulkOperation | getBulkInserter (*int block_size) |
| Returns a bulk insert operation object for the data provider. | |
| AbstractDataProviderBulkRecordInterface | getBulkRecordInterface (int block_size, *hash< auto > search_options) |
| Returns an iterator iterating all records with the bulk read API. | |
| AbstractDataProviderBulkOperation | getBulkUpserter (*int block_size) |
| Returns a bulk upsert operation object for the data provider. | |
| *hash< string, hash< DataProviderOptionInfo > > | getChildCreateOptions () |
| Returns options that can be used for creating child data providers. | |
| *hash< string, hash< DataProviderOptionInfo > > | getChildDeleteOptions () |
| Returns options that can be used for deleting child data providers. | |
| *AbstractDataProvider | getChildProvider (string name) |
| Returns the given child provider or NOTHING if the given child is unknown. | |
| AbstractDataProvider | getChildProviderEx (string name) |
| Returns the given child provider or throws an exception if the given child is unknown. | |
| *list< string > | getChildProviderNames () |
| Returns a list of child data provider names, if any. | |
| AbstractDataProvider | getChildProviderPath (string path) |
Returns the given child provider from a "/" separated path string. | |
| *hash< DataProviderConnectionInfo > | getConnectionInfo () |
| Returns connection info if the data provider supports connections, otherwise returns NOTHING. | |
| *hash< string, hash< DataProviderOptionInfo > > | getCreateOptions () |
| Returns options that can be used for creating records. | |
| *hash< string, hash< ActionOptionInfo > > | getCreateOptionsAsActionOptions () |
| Returns create options as action options. | |
| *hash< string, AbstractDataField > | getCreateRecordType (*hash< auto > create_options) |
| Returns the description of the record type for creating records, if any. | |
| *hash< string, AbstractDataField > | getCreateRecordTypeImpl (*hash< auto > create_options) |
| Returns the description of the record type for creating records, if any. | |
| *hash< string, AbstractDataField > | getCreateRecordTypeWithOptions (*hash< auto > options, *hash< auto > create_options) |
| Returns the description of the record type for creating records in the context of the given options. | |
| *hash< string, AbstractDataField > | getCreateRecordTypeWithOptionsImpl (*hash< auto > options, *hash< auto > create_options) |
| Returns the description of the record type for creating records in the context of the given options. | |
| *AbstractDebugInfoCollector | getDebugCollector () |
| Returns the current debug info collector, if any. | |
| *string | getDesc () |
| Returns the data provider description. | |
| string | getDisplayName () |
| Returns the data provider display name. | |
| *list< hash< AllowedValueInfo > > | getElementReferenceData (string type, *hash< auto > action_opts) |
| Returns element reference data of the given kind if available. | |
| *list< hash< AllowedValueInfo > > | getElementReferenceDataEx (string type, *hash< auto > action_opts) |
| Returns element reference data of the given kind if available. | |
| *list< hash< AllowedValueInfo > > | getElementReferenceDataSafe (string type, *hash< auto > action_opts) |
| Returns element reference data of the given kind if available; logs but ignores exceptions retrieving the data. | |
| *list< hash< AllowedValueInfo > > | getElementReferenceDataSafeEx (string type, *hash< auto > action_opts) |
| Returns element reference data of the given kind if available. | |
| hash< DataProviderExpression > | getEqualityComparisonExpression (auto value, string key, int role, hash< DataProviderInfo > info) |
| Returns an equality comparison expression. | |
| AbstractDataProviderType | getErrorResponseType (string error_code) |
| Returns the type for the given error code. | |
| *hash< string, AbstractDataProviderType > | getErrorResponseTypes () |
| Returns a hash of error responses, if any. | |
| *hash< string, AbstractDataProviderType > | getErrorResponseTypesImpl () |
| Returns a hash of error responses, if any. | |
| *hash< string, AbstractDataProviderType > | getErrorResponseTypesWithOptionsImpl (*hash< auto > options) |
| Returns a hash of error responses, if any, in the context of the given option data. | |
| AbstractDataProviderType | getErrorResponseTypeWithOptionsImpl (string error_code, *hash< auto > options) |
| Returns the type for the given error code in the context of the given option data. | |
| hash< DataProviderMessageInfo > | getEventInfo (string event_id) |
| Returns the description of an observable event, if any. | |
| hash< DataProviderMessageInfo > | getEventInfoImpl (string event_id) |
| Returns the type of an observable event, if any. | |
| hash< DataProviderMessageInfo > | getEventInfoWithOptions (string event_id, *hash< auto > options) |
| Returns the description of an observable event, if any with option data, if any. | |
| hash< DataProviderMessageInfo > | getEventInfoWithOptionsImpl (string event_id, *hash< auto > options) |
| Returns the description of an observable event, if any with option data, if any. | |
| hash< string, hash< DataProviderMessageInfo > > | getEventTypes () |
| Returns a hash of all supported event types. | |
| hash< string, hash< DataProviderMessageInfo > > | getEventTypesImpl () |
| Returns a hash of all supported event types. | |
| hash< string, hash< DataProviderMessageInfo > > | getEventTypesWithOptions (*hash< auto > options) |
| Returns a hash of all supported event types in the context of the given options. | |
| hash< string, hash< DataProviderMessageInfo > > | getEventTypesWithOptionsImpl (*hash< auto > options) |
| Returns a hash of all supported event types in the context of the given options. | |
| auto | getExampleErrorResponseData (string error_code) |
| Returns example data for the error message with the given error code. | |
| auto | getExampleErrorResponseDataImpl (string error_code) |
| Returns example data for the error message with the given error code. | |
| auto | getExampleErrorResponseDataWithOptions (string error_code, *hash< auto > options) |
| Returns example data for the error message with the given error code in the context of the given option data. | |
| auto | getExampleErrorResponseDataWithOptionsImpl (string error_code, *hash< auto > options) |
| Returns example data for the error message with the given error code in the context of the given option data. | |
| auto | getExampleEventData (string event_id) |
| Returns example data for the given observable event. | |
| auto | getExampleEventDataImpl (string event_id) |
| Returns example data for the given observable event. | |
| auto | getExampleEventDataWithOptions (string event_id, *hash< auto > options) |
| Returns example data for the given observable event in the context of the given option data. | |
| auto | getExampleEventDataWithOptionsImpl (string event_id, *hash< auto > options) |
| Returns example data for the given observable event in the context of the given option data. | |
| hash< auto > | getExampleRecordData () |
| Returns example data for the record type. | |
| hash< auto > | getExampleRecordDataImpl () |
| Returns example data for the record type. | |
| hash< auto > | getExampleRecordDataWithOptions (*hash< auto > options) |
| Returns example data for the record type in the context of the given option data. | |
| hash< auto > | getExampleRecordDataWithOptionsImpl (*hash< auto > options) |
| Returns example data for the record type in the context of the given option data. | |
| auto | getExampleRequestData () |
| Returns example data for a request message. | |
| auto | getExampleRequestDataImpl () |
| Returns example data for a request message. | |
| auto | getExampleRequestDataWithOptions (*hash< auto > options) |
| Returns example data for a request message in the context of the given option data. | |
| auto | getExampleRequestDataWithOptionsImpl (*hash< auto > options) |
| Returns example data for a request message in the context of the given option data. | |
| auto | getExampleResponseData () |
| Returns example data for a successful request message. | |
| auto | getExampleResponseDataImpl () |
| Returns example data for a successful request message. | |
| auto | getExampleResponseDataWithOptions (*hash< auto > options) |
| Returns example data for a successful request message in the context of the given option data. | |
| auto | getExampleResponseDataWithOptionsImpl (*hash< auto > options) |
| Returns example data for a successful request message in the context of the given option data. | |
| *hash< string, hash< DataProviderExpressionInfo > > | getExpressionsWithOptions (*hash< auto > options) |
| Returns supported expression in the context of the given option data. | |
| *hash< string, hash< DataProviderOptionInfo > > | getFieldAddOptions () |
| Returns options that can be used for adding new fields to the data provider. | |
| *hash< string, hash< DataProviderOptionInfo > > | getFieldDeleteOptions () |
| Returns options that can be used for deleting fields from the data provider. | |
| *hash< string, hash< DataProviderOptionInfo > > | getFieldUpdateOptions () |
| Returns options that can be used for updating fields of the data provider. | |
| hash< DataProviderInfo > | getInfo () |
| Returns data provider info. | |
| hash< auto > | getInfoAsData (*bool with_type_info) |
| Returns static provider information as data; no objects are returned. | |
| hash< DataProviderMessageInfo > | getMessageInfo (string message_id) |
| Returns the description of an outbound message, if any. | |
| hash< DataProviderMessageInfo > | getMessageInfoImpl (string message_id) |
| Returns the type of an outbound message, if any. | |
| string | getMessageSupport () |
| Returns a code describing how the data provider supports sending messages. | |
| hash< string, hash< DataProviderMessageInfo > > | getMessageTypes () |
| Returns a hash of all supported outbound messages. | |
| hash< string, hash< DataProviderMessageInfo > > | getMessageTypesImpl () |
| Returns a hash of all supported outbound messages. | |
| hash< string, hash< DataProviderMessageInfo > > | getMessageTypesWithOptions (*hash< auto > options) |
| Returns a hash of all supported outbound messages with options. | |
| hash< string, hash< DataProviderMessageInfo > > | getMessageTypesWithOptionsImpl (*hash< auto > options) |
| Returns a hash of all supported outbound messages with options. | |
| abstract string | getName () |
| Returns the data provider name. | |
| *hash< string, hash< ActionOptionInfo > > | getOptionsAsActionOptions (*hash< string, hash< DataProviderOptionInfo > > options) |
| Returns search options as action options. | |
| *hash< string, AbstractDataField > | getOrNothingRecordType (*hash< auto > search_options) |
| Returns the description of the record type with "or nothing" types, if any. | |
| *hash< string, AbstractDataField > | getOrNothingRecordTypeWithOptions (*hash< auto > options, *hash< auto > search_options) |
| Returns the description of the record type with "or nothing" types, if any. | |
| AbstractDataProviderRecordIterator | getRecordIterator (*hash< auto > search_options) |
| Returns an iterator iterating all records. | |
| *hash< string, AbstractDataField > | getRecordType (*hash< auto > search_options) |
| Returns the description of the record type, if any. | |
| *hash< string, AbstractDataField > | getRecordTypeImpl (*hash< auto > search_options) |
| Returns the description of the record type, if any. | |
| *hash< string, AbstractDataField > | getRecordTypeWithOptions (*hash< auto > options, *hash< auto > search_options) |
| Returns the description of the record type in the context of the given options. | |
| *hash< string, AbstractDataField > | getRecordTypeWithOptionsImpl (*hash< auto > options, *hash< auto > search_options) |
| Returns the description of the record type in the context of the given options. | |
| *list< hash< AllowedValueInfo > > | getReferenceData (string type, *hash< auto > action_opts) |
| Returns reference data of the given kind if available. | |
| *list< hash< AllowedValueInfo > > | getReferenceDataEx (string type, *hash< auto > action_opts) |
| Returns reference data of the given kind if available. | |
| *list< hash< AllowedValueInfo > > | getReferenceDataSafe (string type, *hash< auto > action_opts) |
| Returns reference data of the given kind if available; logs but ignores exceptions retrieving the data. | |
| *list< hash< AllowedValueInfo > > | getReferenceDataSafeEx (string type, *hash< auto > action_opts) |
| Returns reference data of the given kind if available. | |
| auto | getReferenceDataValue (string type, *hash< auto > action_opts) |
| Returns a reference data value of the given kind if available. | |
| auto | getReferenceDataValueEx (string type, *hash< auto > action_opts) |
| Returns a reference data value of the given kind if available. | |
| auto | getReferenceDataValueSafe (string type, *hash< auto > action_opts) |
| Returns a reference data value of the given kind if available; logs but ignores exceptions retrieving the data. | |
| auto | getReferenceDataValueSafeEx (string type, *hash< auto > action_opts) |
| Returns reference data of the given kind if available. | |
| *hash< string, hash< DataProviderOptionInfo > > | getRequestOptions () |
| Returns options that can be used for requests. | |
| *AbstractDataProviderType | getRequestType () |
| Returns the description of a successful request message, if any. | |
| *AbstractDataProviderType | getRequestTypeImpl () |
| Returns the description of a successful request message, if any. | |
| *AbstractDataProviderType | getRequestTypeWithData (auto req) |
| Returns the description of a successful request message with call data, if any. | |
| *AbstractDataProviderType | getRequestTypeWithOptions (*hash< auto > options) |
| Returns the description of a successful request message in the context of the given option data. | |
| *AbstractDataProviderType | getRequestTypeWithOptionsImpl (*hash< auto > options) |
| Returns the description of a successful request message in the context of the given option data. | |
| *AbstractDataProviderType | getResponseType () |
| Returns the description of a response message, if this object represents a response message. | |
| *AbstractDataProviderType | getResponseTypeImpl () |
| Returns the description of a response message, if this object represents a response message. | |
| *AbstractDataProviderType | getResponseTypeWithData (auto req) |
| Returns the description of a successful response message with call data, if any. | |
| *AbstractDataProviderType | getResponseTypeWithOptions (*hash< auto > options) |
| Returns the description of a successful response message in the context of the given option data. | |
| *AbstractDataProviderType | getResponseTypeWithOptionsImpl (*hash< auto > options) |
| Returns the description of a successful response message in the context of the given option data. | |
| object | getSchemaObject () |
| Returns the schema supporting this data provider. | |
| object | getSchemaObjectImpl () |
| Returns the schema object supporting this data provider. | |
| *object | getSchemaType () |
| Returns the schema type for this data provider or NOTHING if no schema type is supported. | |
| *hash< auto > | getSearchExpression (*hash< auto > where_cond, *hash< auto > search_options) |
| Returns a search expression for a standard search hash. | |
| *hash< string, hash< DataProviderOptionInfo > > | getSearchOptions () |
| Returns options that can be used for searching. | |
| hash< string, hash< ActionOptionInfo > > | getSearchOptionsAsActionOptions () |
| Returns search options as action options. | |
| *hash< string, hash< DataProviderOptionInfo > > | getSendMessageOptions () |
| Returns options that can be used for sending messages from the data provider. | |
| *string | getShortDesc () |
| Returns the data provider short description. | |
| *hash< string, AbstractDataField > | getSoftRecordType (*hash< auto > search_options) |
| Returns the description of the record type with soft types, if any. | |
| *hash< string, AbstractDataField > | getSoftRecordTypeWithOptions (*hash< auto > options, *hash< auto > search_options) |
| Returns the description of the record type with soft types, if any. | |
| abstract hash< DataProviderInfo > | getStaticInfoImpl () |
| Returns data provider static info. | |
| hash< DataProviderSummaryInfo > | getSummaryInfo () |
| Return data provider summary info. | |
| *hash< string, AbstractDataField > | getUpdateRecordType (*hash< auto > search_options) |
| Returns the description of the record type for updating records, if any. | |
| *hash< string, AbstractDataField > | getUpdateRecordTypeImpl (*hash< auto > search_options) |
| Returns the description of the record type for updates, if any. | |
| *hash< string, AbstractDataField > | getUpdateRecordTypeWithOptions (*hash< auto > options, *hash< auto > search_options) |
| Returns the description of the record type for updating records in the context of the given options. | |
| *hash< string, AbstractDataField > | getUpdateRecordTypeWithOptionsImpl (*hash< auto > options, *hash< auto > search_options) |
| Returns the description of the record type for updating records in the context of the given options. | |
| *hash< string, hash< DataProviderOptionInfo > > | getUpsertOptions () |
| Returns options that can be used for upserting records. | |
| *hash< string, hash< ActionOptionInfo > > | getUpsertOptionsAsActionOptions () |
| Returns upsert options as action options. | |
| hash< ActionOptionInfo > | getWhereCondActionOption (*hash< string, hash< DataProviderExpressionInfo > > expressions) |
| Returns an action where condition option in the context of the given option data. | |
| bool | hasRecord () |
| Returns True if the data provider has a record type. | |
| void | processConstructorOptions (*string required_options, *hash< string, hash< DataProviderOptionInfo > > option_desc, *hash< auto > options) |
| Processes options passed to the constructor. | |
| *hash< DataProviderExpression > | processSearchParameters (*hash< DataProviderExpression > exp, *hash< auto > search_options) |
| processes search parameter expressions | |
| bool | recordRequiresSearchOptions () |
| Returns True if the data provider requires search options to retrieve the record type. | |
| AbstractDataProviderRecordIterator | requestSearchRecords (*hash< auto > search_options, auto req, *hash< auto > where_cond) |
| Returns an iterator for zero or more records matching the search options according to an API request. | |
| AbstractDataProviderRecordIterator | requestSearchRecords (*hash< auto > search_options, auto req, *hash< DataProviderExpression > where_cond) |
| Returns an iterator for zero or more records matching the search options according to an API request. | |
| AbstractDataProviderRecordIterator | requestSearchRecordsImpl (*hash< auto > search_options, auto req, *hash< auto > where_cond) |
| Returns an iterator for zero or more records matching the search options according to an API request. | |
| bool | requiresTransactionManagement () |
| Returns True if the data provider requires transaction management. | |
| void | rollback () |
| Rolls back data written to the data provider. | |
| bool | searchAcceptsForeignField (string field) |
| Allows data providers to accept foreign or virtual field names. | |
| *hash< auto > | searchFirstRecord (hash< auto > where_cond, *hash< auto > search_options) |
| Returns the first record matching the search options. | |
| *hash< auto > | searchFirstRecord (hash< DataProviderExpression > where_cond, *hash< auto > search_options) |
| Returns the first record matching the search options. | |
| *hash< auto > | searchFirstRecordWithOptions (*hash< auto > options) |
| Returns the first record matching the search action options. | |
| AbstractDataProviderRecordIterator | searchRecords (*hash< auto > where_cond, *hash< auto > search_options) |
| Returns an iterator for zero or more records matching the search options. | |
| AbstractDataProviderRecordIterator | searchRecords (*hash< DataProviderExpression > where_cond, *hash< auto > search_options) |
| Returns an iterator for zero or more records matching the search options. | |
| AbstractDataProviderBulkRecordInterface | searchRecordsBulk (int block_size, *hash< auto > search_options, *hash< auto > where_cond) |
| Returns an iterator for zero or more records matching the search options. | |
| AbstractDataProviderBulkRecordInterface | searchRecordsBulk (int block_size, *hash< auto > search_options, *hash< DataProviderExpression > where_cond) |
| Returns an iterator for zero or more records matching the search options. | |
| AbstractDataProviderBulkRecordInterface | searchRecordsBulkImpl (int block_size, *hash< auto > search_options, *hash< auto > where_cond) |
| Returns an iterator for zero or more records matching the search options. | |
| AbstractDataProviderBulkRecordInterface | searchRecordsBulkWithOptions (*hash< auto > options) |
| Returns an iterator for zero or more records matching the search action options. | |
| AbstractDataProviderRecordIterator | searchRecordsImpl (*hash< auto > where_cond, *hash< auto > search_options) |
| Returns an iterator for zero or more records matching the search options. | |
| AbstractDataProviderRecordIterator | searchRecordsWithOptions (*hash< auto > options) |
| Returns an iterator for zero or more records matching the search action options. | |
| *hash< auto > | searchSingleRecord (*hash< auto > where_cond, *hash< auto > search_options) |
| Returns a single record matching the search options. | |
| *hash< auto > | searchSingleRecord (hash< DataProviderExpression > where_cond, *hash< auto > search_options) |
| Returns a single record matching the search options. | |
| *hash< auto > | searchSingleRecordWithOptions (*hash< auto > options) |
| Returns a single record matching the search action options. | |
| void | sendMessage (*hash< auto > send_message_options, string message_id, auto msg) |
| Sends a message from message-capable data providers. | |
| void | sendMessageImpl (*hash< auto > send_message_options, string message_id, auto msg) |
| Sends a message from message-capable data providers. | |
| void | setDebugCollector (*AbstractDebugInfoCollector collector) |
| Sets the debug info collector for this data provider. | |
| bool | supportsAddField () |
| Returns True if the data provider supports creating adding new fields. | |
| bool | supportsBulkCreate () |
| Returns True if the data provider supports bulk creation output. | |
| bool | supportsBulkRead () |
| Returns True if the data provider supports native bulk reading. | |
| bool | supportsBulkUpsert () |
| Returns True if the data provider supports bulk upserts. | |
| bool | supportsChildren () |
| Returns True if the data provider supports children. | |
| bool | supportsCreate () |
| Returns True if the data provider supports the record creation API. | |
| bool | supportsCreateChild () |
| Returns True if the data provider supports creating new child data providers. | |
| bool | supportsDelete () |
| Returns True if the data provider supports the record deletion API. | |
| bool | supportsDeleteChild () |
| Returns True if the data provider supports creating deleting child data providers. | |
| bool | supportsDeleteField () |
| Returns True if the data provider supports deleting existing fields. | |
| bool | supportsMessages () |
| Returns True if the data provider supports sending messages. | |
| bool | supportsNativeSearch () |
| Returns True if the data provider supports the record search API natively. | |
| bool | supportsObservable () |
| Returns True if the data provider supports the observer pattern / event API. | |
| bool | supportsRead () |
| Returns True if the data provider supports reading. | |
| bool | supportsRequest () |
| Returns True if the data provider supports requests. | |
| bool | supportsSchema () |
| Returns True if the data provider supports a schema. | |
| bool | supportsSearchExpressions () |
| Returns True if the data provider supports advanced search expressions. | |
| bool | supportsUpdate () |
| Returns True if the data provider supports the record update API. | |
| bool | supportsUpdateField () |
| Returns True if the data provider supports updating existing fields. | |
| bool | supportsUpsert () |
| Returns True if the data provider supports the record upsert API. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsForCreateWithOptions (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data for a create action. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsForCreateWithOptionsImpl (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data for a create action. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsForDeleteWithOptions (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data for a delete action. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsForDeleteWithOptionsImpl (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data for a delete action. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsForEventWithOptions (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data for an event action. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsForEventWithOptionsImpl (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data for an event action. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsForMessageWithOptions (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data for a send message action. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsForMessageWithOptionsImpl (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data for a send message action. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsForRequestWithOptions (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data for a request action. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsForRequestWithOptionsImpl (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data for a request action. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsForSearchWithOptions (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data for a search action. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsForSearchWithOptionsImpl (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data for a search action. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsForUpdateWithOptions (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data for an update action. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsForUpdateWithOptionsImpl (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data for an update action. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsForUpsertWithOptions (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data for an upsert action. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsForUpsertWithOptionsImpl (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data for an upsert action. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsFromRequestTypeWithData (auto req) |
| Returns action options corresponding to the request type with the given request data, if possible. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsWithOptions (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data. | |
| *hash< string, hash< ActionOptionInfo > > | tryGetActionOptionsWithOptionsImpl (hash< DataProviderActionInfo > action, *hash< auto > options) |
| Returns action options corresponding to the given option data. | |
| void | updateField (*hash< auto > field_update_options, string name, AbstractDataField field) |
| Updates an existing field. | |
| void | updateFieldImpl (*hash< auto > field_update_options, string name, AbstractDataField field) |
| Updates an existing field. | |
| int | updateRecords (*hash< auto > search_options, hash< auto > set, *hash< auto > where_cond) |
| Updates zero or more records matching the search options. | |
| int | updateRecords (*hash< auto > search_options, hash< auto > set, *hash< DataProviderExpression > where_cond) |
| Updates zero or more records matching the search options. | |
| int | updateRecordsImpl (*hash< auto > search_options, hash< auto > set, *hash< auto > where_cond) |
| Updates zero or more records matching the search options. | |
| int | updateRecordsWithOptions (*hash< auto > options) |
| Updates zero or more records matching the update action options. | |
| bool | updateSingleRecord (*hash< auto > search_options, hash< auto > set, hash< auto > where_cond) |
| Updates a single record matching the search options. | |
| bool | updateSingleRecord (*hash< auto > search_options, hash< auto > set, hash< DataProviderExpression > where_cond) |
| Updates a single record matching the search options. | |
| bool | updateSingleRecordImpl (*hash< auto > search_options, hash< auto > set, hash< auto > where_cond) |
| Updates a single record matching the search options. | |
| bool | updateSingleRecordWithOptions (*hash< auto > options) |
| Updates a single record using update action options. | |
| string | upsertRecord (hash< auto > rec, *hash< auto > upsert_options) |
| Upserts the given record in the data provider. | |
| string | upsertRecordImpl (hash< auto > rec, *hash< auto > upsert_options) |
| Upserts the given record to the data provider. | |
| *list< string > | upsertRecordsBulk (AbstractDataProviderBulkRecordInterface stream, *hash< auto > upsert_options) |
| Upserts the given records in the data provider. | |
| *list< string > | upsertRecordsBulk (hash< auto > recs, *hash< auto > upsert_options) |
| Upserts the given records in the data provider. | |
| *list< string > | upsertRecordsBulk (HashListIterator i, *hash< auto > upsert_options) |
| Upserts the given records in the data provider. | |
| *list< string > | upsertRecordsBulk (list< auto > recs, *hash< auto > upsert_options) |
| Creates the given records in the data provider. | |
| *list< string > | upsertRecordsBulkImpl (hash< auto > recs, *hash< auto > upsert_options) |
| Upserts the given records in the data provider. | |
| *list< string > | upsertRecordsBulkWithOptions (*hash< auto > options) |
| Upserts the given records in the data provider from upsert action options. | |
| string | upsertRecordWithOptions (*hash< auto > options) |
| Upserts the given record in the data provider from upsert action options. | |
| *hash< auto > | validateChildCreateOptions (*hash< auto > child_create_options) |
| validates child create options | |
| *hash< auto > | validateChildDeleteOptions (*hash< auto > child_delete_options) |
| validates child delete options | |
| *hash< auto > | validateCreateOptions (*hash< auto > create_options) |
| validates create options | |
| *hash< auto > | validateFieldAddOptions (*hash< auto > field_add_options) |
| validates field add options | |
| *hash< auto > | validateFieldDeleteOptions (*hash< auto > field_delete_options) |
| validates field delete options | |
| *hash< auto > | validateFieldUpdateOptions (*hash< auto > field_update_options) |
| validates field update options | |
| *hash< auto > | validateRequestOptions (*hash< auto > request_options) |
| validates request options | |
| *hash< auto > | validateSearchOptions (*hash< auto > search_options) |
| validates search options | |
| *hash< auto > | validateSendMessageOptions (*hash< auto > send_message_options) |
| validates send message options | |
| *hash< auto > | validateUpsertOptions (*hash< auto > upsert_options) |
| validates upsert options | |
Static Public Member Methods | |
| static bool | checkCallbacks () |
| Checks if callbacks have already been set or locked. | |
| static auto | evalGenericExpression (hash< auto > rec, hash< DataProviderExpression > exp) |
| Evaluates the given expression with the generic internal implementation and returns the result. | |
| static hash< DataProviderExpressionInfo > | getExpression (*hash< string, hash< DataProviderExpressionInfo > > expmap, int role, string exp) |
| Returns an expression definition for an expression code or throws an exception. | |
| static void | registerChild (string name, code generator) |
| Registers a child data provider if the data provider supports children and is extensible. | |
| static bool | setDynamicValueCallbacks () |
| Ensures that no callbacks can be set for dynamic URI resolution. | |
| static bool | setDynamicValueCallbacks (code value_needs_resolution, code resolve_value) |
| Set callbacks for dynamic URI resolution to allow for variable URI path elements to be resolved at runtime. | |
| static void | verifyExpression (hash< DataProviderExpression > exp, AbstractDataProviderType expected_type, int caps, int role, *hash< string, hash< DataProviderExpressionInfo > > expmap) |
| processes an expression in a certain context | |
| static void | verifyExpressionArgValue (int pos, softlist< auto > values, hash< DataProviderExpressionInfo > expinfo, int role, int caps) |
| processes an expression in a certain context | |
The AbstractDataProvider class.
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::addCreateRecordOption | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Adds a record option to the given action options based on the given option data.
| void DataProvider::AbstractDataProvider::addField | ( | AbstractDataField | field, |
| *hash< auto > | field_add_options | ||
| ) |
Creates a new field.
| field | the field to add |
| field_add_options | the options for adding the new field |
| INVALID-OPERATION | thrown if the data provider does not support this API |
| ADD-FIELD-ERROR | error adding the field |
| void DataProvider::AbstractDataProvider::addFieldImpl | ( | AbstractDataField | field, |
| *hash< auto > | field_add_options | ||
| ) |
Creates a new field.
| field | the field to add |
| field_add_options | the options for adding the new field |
| void DataProvider::AbstractDataProvider::beginTransaction | ( | ) |
Begins a transaction with a data provider.
Has no effect if the data provider does not require transaction management
| void DataProvider::AbstractDataProvider::checkAddField | ( | ) |
Ensures that the data provider supports adding fields.
| INVALID-OPERATION | the data provider does not support the add field API |
| void DataProvider::AbstractDataProvider::checkCreate | ( | ) |
Ensures that the data provider supports record creation.
| INVALID-OPERATION | the data provider does not support record creation |
| void DataProvider::AbstractDataProvider::checkCreateChild | ( | ) |
Ensures that the data provider supports creating children.
| INVALID-OPERATION | the data provider does not support the child creation API |
| void DataProvider::AbstractDataProvider::checkDelete | ( | ) |
Ensures that the data provider supports record deletion.
| INVALID-OPERATION | the data provider does not support record deletion |
| void DataProvider::AbstractDataProvider::checkDeleteChild | ( | ) |
Ensures that the data provider supports deleting children.
| INVALID-OPERATION | the data provider does not support the child deletion API |
| void DataProvider::AbstractDataProvider::checkDeleteField | ( | ) |
Ensures that the data provider supports deleting fields.
| INVALID-OPERATION | the data provider does not support the delete field API |
| void DataProvider::AbstractDataProvider::checkMessages | ( | ) |
Ensures that the data provider supports sending messages.
| INVALID-OPERATION | the data provider does not support sending messages |
| void DataProvider::AbstractDataProvider::checkObservable | ( | ) |
Ensures that the data provider supports observer pattern / event API.
| INVALID-OPERATION | the data provider does not support the observer pattern / event API |
| void DataProvider::AbstractDataProvider::checkRead | ( | ) |
Ensures that the data provider supports read operations.
| INVALID-OPERATION | the data provider does not support read operations |
| void DataProvider::AbstractDataProvider::checkRequest | ( | ) |
Ensures that the data provider supports the request API.
| INVALID-OPERATION | the data provider does not support the request API |
| void DataProvider::AbstractDataProvider::checkSchema | ( | ) |
Ensures that the data provider supports a schema.
| INVALID-OPERATION | the data provider does not support a schema |
| void DataProvider::AbstractDataProvider::checkSearchExpressions | ( | ) |
Ensures that the data provider supports advanced search expressions.
| INVALID-OPERATION | the data provider does not support advanced search expressions |
| void DataProvider::AbstractDataProvider::checkUpdate | ( | ) |
Ensures that the data provider supports record upserts.
| INVALID-OPERATION | the data provider does not support record updating |
| void DataProvider::AbstractDataProvider::checkUpdateField | ( | ) |
Ensures that the data provider supports updating fields.
| INVALID-OPERATION | the data provider does not support the update field API |
| void DataProvider::AbstractDataProvider::checkUpsert | ( | ) |
Ensures that the data provider supports record upserts.
| INVALID-OPERATION | the data provider does not support upsert operations |
| bool DataProvider::AbstractDataProvider::childrenIdentical | ( | ) |
Returns True if the data provider's children are all of the same class and all support the same options.
| void DataProvider::AbstractDataProvider::collectDebugInfo | ( | hash< DataProviderDebugInfo > | info | ) |
Collects debug info if a collector is registered.
| info | the debug information to collect |
Subclasses should call this method to report debug information when performing operations. If no collector is registered, this method does nothing.
| void DataProvider::AbstractDataProvider::commit | ( | ) |
Commits data written to the data provider.
Has no effect if the data provider does not support transaction management
| AbstractDataProvider DataProvider::AbstractDataProvider::createChildProvider | ( | *hash< auto > | child_create_options, |
| string | name, | ||
| hash< string, AbstractDataField > | fields | ||
| ) |
Creates a new child data provider and returns it after adding as a child.
| name | the name of the new child data provider |
| fields | the fields for the new child data provider; must have at least one field |
| child_create_options | the options for creating the new child data provider |
| INVALID-OPERATION | thrown if the data provider does not support this API |
| CREATE-CHILD-PROVIDER-ERROR | error creating the child provider |
| AbstractDataProvider DataProvider::AbstractDataProvider::createChildProviderImpl | ( | *hash< auto > | child_create_options, |
| string | name, | ||
| hash< string, AbstractDataField > | fields | ||
| ) |
Creates a new child data provider and returns it after adding as a child.
| name | the name of the new child data provider |
| fields | the fields for the new child data provider |
| child_create_options | the options for creating the new child data provider |
| *hash< auto > DataProvider::AbstractDataProvider::createRecord | ( | hash< auto > | rec, |
| *hash< auto > | create_options | ||
| ) |
Creates the given record in the data provider.
| rec | a hash representing a single input record |
| create_options | the create options; will be processed by validateCreateOptions() |
| INVALID-OPERATION | the data provider does not support record creation |
| CREATE-RECORD-ERROR | the data provider raised an exception in the record creation operation |
| DUPLICATE-RECORD | this exception should be thrown if the provider fails due to an attempt to create a duplicate record |
| *hash< auto > DataProvider::AbstractDataProvider::createRecordImpl | ( | hash< auto > | rec, |
| *hash< auto > | create_options | ||
| ) |
Creates the given record in the data provider.
| rec | a hash representing a single input record |
| create_options | the create options after processing by validateCreateOptions() |
| *hash< auto > DataProvider::AbstractDataProvider::createRecordsBulk | ( | AbstractDataProviderBulkRecordInterface | stream, |
| *hash< auto > | create_options | ||
| ) |
Creates the given records in the data provider.
| stream | a record stream for insert |
| create_options | the create options after processing by validateCreateOptions() |
| DUPLICATE-RECORD | this exception should be thrown if the provider fails due to an attempt to create a duplicate record |
| *hash< auto > DataProvider::AbstractDataProvider::createRecordsBulk | ( | hash< auto > | recs, |
| *hash< auto > | create_options | ||
| ) |
Creates the given records in the data provider.
| recs | a hash representing multiple input records, where the keys are field names and values are either lists of field values or a single value that applies to all records |
| create_options | the create options after processing by validateCreateOptions() |
| DUPLICATE-RECORD | this exception should be thrown if the provider fails due to an attempt to create a duplicate record |
| *hash< auto > DataProvider::AbstractDataProvider::createRecordsBulk | ( | HashListIterator | i, |
| *hash< auto > | create_options | ||
| ) |
Creates the given records in the data provider.
| i | a record iterator for insert |
| create_options | the create options after processing by validateCreateOptions() |
| DUPLICATE-RECORD | this exception should be thrown if the provider fails due to an attempt to create a duplicate record |
| *hash< auto > DataProvider::AbstractDataProvider::createRecordsBulk | ( | list< auto > | recs, |
| *hash< auto > | create_options | ||
| ) |
Creates the given records in the data provider.
| recs | a list of hashes representing input records, where the keys are field names and values are field values |
| create_options | the create options after processing by validateCreateOptions() |
| DUPLICATE-RECORD | this exception should be thrown if the provider fails due to an attempt to create a duplicate record |
| *hash< auto > DataProvider::AbstractDataProvider::createRecordsBulkImpl | ( | hash< auto > | recs, |
| *hash< auto > | create_options | ||
| ) |
Creates the given records in the data provider.
| recs | a hash representing multiple input records, where the keys are field names and values are either lists of field values or a single value that applies to all records |
| create_options | the create options after processing by validateCreateOptions() |
| *hash< auto > DataProvider::AbstractDataProvider::createRecordsBulkIntern | ( | hash< auto > | recs, |
| *hash< auto > | create_options | ||
| ) |
Creates the given records in the data provider.
| recs | a hash representing multiple input records, where the keys are field names and values are either lists of field values or a single value that applies to all records |
| create_options | the create options after processing by validateCreateOptions() |
| *hash< auto > DataProvider::AbstractDataProvider::createRecordsBulkWithOptions | ( | *hash< auto > | options | ) |
Creates the given records in the data provider from create action options.
| options | create action options |
| DUPLICATE-RECORD | this exception should be thrown if the provider fails due to an attempt to create a duplicate record |
| *hash< auto > DataProvider::AbstractDataProvider::createRecordWithOptions | ( | *hash< auto > | options | ) |
Creates the given record in the data provider from create action options.
| options | create action options |
| INVALID-OPERATION | the data provider does not support record creation |
| CREATE-RECORD-ERROR | the data provider raised an exception in the record creation operation |
| DUPLICATE-RECORD | this exception should be thrown if the provider fails due to an attempt to create a duplicate record |
| bool DataProvider::AbstractDataProvider::currentThreadInTransaction | ( | ) |
Returns True if the current thread is in a transaction.
| INVALID-OPERATION | the data provider does not support transaction management |
| bool DataProvider::AbstractDataProvider::currentThreadInTransactionImpl | ( | ) |
| bool DataProvider::AbstractDataProvider::debugCollectionEnabled | ( | ) |
Returns True if debug collection is enabled.
| void DataProvider::AbstractDataProvider::deleteChildProvider | ( | string | name, |
| *hash< auto > | child_delete_options | ||
| ) |
Deletes a child data provider.
| name | the name of the new child data provider |
| child_delete_options | the options for deleting a child data provider |
| INVALID-OPERATION | thrown if the data provider does not support this API |
| DELETE-CHILD-PROVIDER-ERROR | error creating the child provider |
| void DataProvider::AbstractDataProvider::deleteChildProviderImpl | ( | string | name, |
| *hash< auto > | child_delete_options | ||
| ) |
Deletes a child data provider.
| name | the name of the new child data provider |
| child_delete_options | the options for deleting a child data provider |
| void DataProvider::AbstractDataProvider::deleteField | ( | string | name, |
| *hash< auto > | field_delete_options | ||
| ) |
Deletes an existing field.
| name | the name of the field to delete |
| field_delete_options | the options for deleting the new field; processed by validateFieldDeleteOptions() |
| INVALID-OPERATION | thrown if the data provider does not support this API |
| DELETE-FIELD-ERROR | error adding the field |
| void DataProvider::AbstractDataProvider::deleteFieldImpl | ( | string | name, |
| *hash< auto > | field_delete_options | ||
| ) |
Deletes an existing field.
| name | the name of the field to delete |
| field_delete_options | the options for deleting the new field |
| int DataProvider::AbstractDataProvider::deleteRecords | ( | *hash< auto > | where_cond, |
| *hash< auto > | search_options | ||
| ) |
Deletes zero or more records.
| where_cond | a hash for identifying the record(s) to be deleted; will be processed by processFieldValues() |
| search_options | the search options; will be processed by validateSearchOptions() |
| INVALID-OPERATION | the data provider does not support record deletion |
| DELETE-RECORDS-ERROR | error deleting records |
| int DataProvider::AbstractDataProvider::deleteRecords | ( | *hash< DataProviderExpression > | where_cond, |
| *hash< auto > | search_options | ||
| ) |
Deletes zero or more records.
| where_cond | a hash for identifying the record(s) to be deleted; will be processed by processSearchParameters() |
| search_options | the search options; will be processed by validateSearchOptions() |
| INVALID-OPERATION | the data provider does not support record deletion |
| DELETE-RECORDS-ERROR | error deleting records |
| int DataProvider::AbstractDataProvider::deleteRecordsImpl | ( | *hash< auto > | where_cond, |
| *hash< auto > | search_options | ||
| ) |
Deletes zero or more records.
| where_cond | a hash for identifying the record(s) to be deleted |
| search_options | the delete options after processing by validateSearchOptions() |
| int DataProvider::AbstractDataProvider::deleteRecordsWithOptions | ( | *hash< auto > | options | ) |
Deletes zero or more records from delete action options.
| options | action options |
| INVALID-OPERATION | the data provider does not support record deletion |
| DELETE-RECORDS-ERROR | error deleting records |
| auto DataProvider::AbstractDataProvider::doRequest | ( | auto | req, |
| *hash< auto > | request_options | ||
| ) |
Makes a request and returns the response.
| req | the request to serialize and make according to the request type |
| request_options | the request options; will be processed by validateRequestOptions() |
| INVALID-OPERATION | the data provider does not support the request API |
| INVALID-REQUEST | the request argument provided do not match the expected request type |
| auto DataProvider::AbstractDataProvider::doRequestImpl | ( | auto | req, |
| *hash< auto > | request_options | ||
| ) |
Makes a request and returns the response.
| req | the request to serialize and make according to the request type |
| request_options | the request options; will be processed by validateRequestOptions() |
|
static |
Evaluates the given expression with the generic internal implementation and returns the result.
| hash< auto > DataProvider::AbstractDataProvider::generateExampleData | ( | hash< string, AbstractDataField > | fields | ) |
Generates example data for the given fields.
| fields | the fields to generate data for |
| *hash< auto > DataProvider::AbstractDataProvider::getAdditionalInfo | ( | ) |
Returns additional provider-specific information.
| AbstractDataProviderBulkOperation DataProvider::AbstractDataProvider::getBulkInserter | ( | *int | block_size | ) |
Returns a bulk insert operation object for the data provider.
| block_size | the block size for the bulk operation; if not given, the default block size for the data provider is used (normally 1000 records) |
| INVALID-OPERATION | the data provider does not support create operations |
| AbstractDataProviderBulkRecordInterface DataProvider::AbstractDataProvider::getBulkRecordInterface | ( | int | block_size, |
| *hash< auto > | search_options | ||
| ) |
Returns an iterator iterating all records with the bulk read API.
| block_size | the number of records in a read block; must be a positive number |
| search_options | the search options; will be processed by validateSearchOptions() |
| INVALID-BLOCK-SIZE | the block size must be a positive number |
| INVALID-OPERATION | the data provider does not support reading |
| AbstractDataProviderBulkOperation DataProvider::AbstractDataProvider::getBulkUpserter | ( | *int | block_size | ) |
Returns a bulk upsert operation object for the data provider.
| block_size | the block size for the bulk operation; if not given, the default block size for the data provider is used (normally 1000 records) |
| INVALID-OPERATION | the data provider does not support upsert operations |
| *hash< string, hash< DataProviderOptionInfo > > DataProvider::AbstractDataProvider::getChildCreateOptions | ( | ) |
Returns options that can be used for creating child data providers.
| *hash< string, hash< DataProviderOptionInfo > > DataProvider::AbstractDataProvider::getChildDeleteOptions | ( | ) |
Returns options that can be used for deleting child data providers.
| *AbstractDataProvider DataProvider::AbstractDataProvider::getChildProvider | ( | string | name | ) |
Returns the given child provider or NOTHING if the given child is unknown.
| name | the name of the child |
| INVALID-CHILD-PROVIDER | unknown child provider |
| AbstractDataProvider DataProvider::AbstractDataProvider::getChildProviderEx | ( | string | name | ) |
Returns the given child provider or throws an exception if the given child is unknown.
| name | the name of the child |
| INVALID-CHILD-PROVIDER | unknown child provider |
| *list< string > DataProvider::AbstractDataProvider::getChildProviderNames | ( | ) |
Returns a list of child data provider names, if any.
| AbstractDataProvider DataProvider::AbstractDataProvider::getChildProviderPath | ( | string | path | ) |
Returns the given child provider from a "/" separated path string.
throws an exception with unknown path elements
| path | a string giving a path to the target provider where child elements are separated by "/" characters |
| INVALID-CHILD-PROVIDER | unknown child provider |
| *hash< DataProviderConnectionInfo > DataProvider::AbstractDataProvider::getConnectionInfo | ( | ) |
Returns connection info if the data provider supports connections, otherwise returns NOTHING.
| *hash< string, hash< DataProviderOptionInfo > > DataProvider::AbstractDataProvider::getCreateOptions | ( | ) |
Returns options that can be used for creating records.
| *hash< string, AbstractDataField > DataProvider::AbstractDataProvider::getCreateRecordType | ( | *hash< auto > | create_options | ) |
Returns the description of the record type for creating records, if any.
| create_options | the create options; will be processed by validateCreateOptions() |
| *hash< string, AbstractDataField > DataProvider::AbstractDataProvider::getCreateRecordTypeImpl | ( | *hash< auto > | create_options | ) |
Returns the description of the record type for creating records, if any.
| create_options | the create options |
| *hash< string, AbstractDataField > DataProvider::AbstractDataProvider::getCreateRecordTypeWithOptions | ( | *hash< auto > | options, |
| *hash< auto > | create_options | ||
| ) |
Returns the description of the record type for creating records in the context of the given options.
| options | action options that may influence the record type |
| create_options | the create options; will be processed by validateCreateOptions() |
| *hash< string, AbstractDataField > DataProvider::AbstractDataProvider::getCreateRecordTypeWithOptionsImpl | ( | *hash< auto > | options, |
| *hash< auto > | create_options | ||
| ) |
Returns the description of the record type for creating records in the context of the given options.
| options | action options that may influence the record type |
| create_options | the create options; will be processed by validateCreateOptions() |
| *AbstractDebugInfoCollector DataProvider::AbstractDataProvider::getDebugCollector | ( | ) |
Returns the current debug info collector, if any.
| string DataProvider::AbstractDataProvider::getDisplayName | ( | ) |
Returns the data provider display name.
| *list< hash< AllowedValueInfo > > DataProvider::AbstractDataProvider::getElementReferenceData | ( | string | type, |
| *hash< auto > | action_opts | ||
| ) |
Returns element reference data of the given kind if available.
| type | the unique type name of the element reference data |
| action_opts | an optional hash of action options when called when working with an app action |
| ELEMENT-REFERENCE-DATA-ERROR | thrown if there is an error retrieving the element reference data |
| *list< hash< AllowedValueInfo > > DataProvider::AbstractDataProvider::getElementReferenceDataEx | ( | string | type, |
| *hash< auto > | action_opts | ||
| ) |
Returns element reference data of the given kind if available.
| type | the unique type name of the element reference data |
| action_opts | an optional hash of action options when called when working with an app action |
| ELEMENT-REFERENCE-DATA-ERROR | thrown if there is an error retrieving the element reference data |
| UNSUPPORTED-ELEMENT-REFERENCE-DATA | thrown if type is not supported as element reference data |
| *list< hash< AllowedValueInfo > > DataProvider::AbstractDataProvider::getElementReferenceDataSafe | ( | string | type, |
| *hash< auto > | action_opts | ||
| ) |
Returns element reference data of the given kind if available; logs but ignores exceptions retrieving the data.
| type | the unique type name of the element reference data |
| action_opts | an optional hash of action options when called when working with an app action |
| *list< hash< AllowedValueInfo > > DataProvider::AbstractDataProvider::getElementReferenceDataSafeEx | ( | string | type, |
| *hash< auto > | action_opts | ||
| ) |
Returns element reference data of the given kind if available.
| type | the unique type name of the element reference data |
| action_opts | an optional hash of action options when called when working with an app action |
Logs but ignores exceptions retrieving the data; throws an exception if the data type is unsupported
| UNSUPPORTED-ELEMENT-REFERENCE-DATA | thrown if type is not supported as element reference data |
| hash< DataProviderExpression > DataProvider::AbstractDataProvider::getEqualityComparisonExpression | ( | auto | value, |
| string | key, | ||
| int | role, | ||
| hash< DataProviderInfo > | info | ||
| ) |
Returns an equality comparison expression.
Must be reimplemented by data provider implementations that support expressions and use a symbol different from '=' for the comparison operator
| AbstractDataProviderType DataProvider::AbstractDataProvider::getErrorResponseType | ( | string | error_code | ) |
Returns the type for the given error code.
| error_code | the error code for the response; must be a known error code, or an UNKNOWN-ERROR-RESPONSE exception is thrown |
| INVALID-OPERATION | the data provider does not support the request API |
| UNKNOWN-ERROR-RESPONSE | the error response given is not known |
| *hash< string, AbstractDataProviderType > DataProvider::AbstractDataProvider::getErrorResponseTypes | ( | ) |
Returns a hash of error responses, if any.
| INVALID-OPERATION | the data provider does not support the request API |
| *hash< string, AbstractDataProviderType > DataProvider::AbstractDataProvider::getErrorResponseTypesImpl | ( | ) |
Returns a hash of error responses, if any.
| *hash< string, AbstractDataProviderType > DataProvider::AbstractDataProvider::getErrorResponseTypesWithOptionsImpl | ( | *hash< auto > | options | ) |
Returns a hash of error responses, if any, in the context of the given option data.
| AbstractDataProviderType DataProvider::AbstractDataProvider::getErrorResponseTypeWithOptionsImpl | ( | string | error_code, |
| *hash< auto > | options | ||
| ) |
Returns the type for the given error code in the context of the given option data.
| error_code | the error code for the response; must be a known error code, or an UNKNOWN-ERROR-RESPONSE exception is thrown |
| options | option data that can be used to determine the final type |
| UNKNOWN-ERROR-RESPONSE | the error response given is not known |
| hash< DataProviderMessageInfo > DataProvider::AbstractDataProvider::getEventInfo | ( | string | event_id | ) |
Returns the description of an observable event, if any.
| event_id | the event ID of the event |
| INVALID-OPERATION | the data provider does not support the observer pattern / event API |
| INVALID-EVENT | the event_id is not valid |
| hash< DataProviderMessageInfo > DataProvider::AbstractDataProvider::getEventInfoImpl | ( | string | event_id | ) |
Returns the type of an observable event, if any.
| event_id | the event ID of the event |
| INVALID-EVENT | the event is not supported by this data provider |
| hash< DataProviderMessageInfo > DataProvider::AbstractDataProvider::getEventInfoWithOptions | ( | string | event_id, |
| *hash< auto > | options | ||
| ) |
Returns the description of an observable event, if any with option data, if any.
| event_id | the event ID of the event |
| options | example option data that can be used to determine the final type |
| INVALID-OPERATION | the data provider does not support the observer pattern / event API |
| INVALID-EVENT | the event_id is not valid |
| hash< DataProviderMessageInfo > DataProvider::AbstractDataProvider::getEventInfoWithOptionsImpl | ( | string | event_id, |
| *hash< auto > | options | ||
| ) |
Returns the description of an observable event, if any with option data, if any.
| event_id | the event ID of the event |
| options | example option data that can be used to determine the final type |
| INVALID-EVENT | the event_id is not valid |
| hash< string, hash< DataProviderMessageInfo > > DataProvider::AbstractDataProvider::getEventTypes | ( | ) |
Returns a hash of all supported event types.
| INVALID-OPERATION | the data provider does not support the observer pattern / event API |
| hash< string, hash< DataProviderMessageInfo > > DataProvider::AbstractDataProvider::getEventTypesImpl | ( | ) |
Returns a hash of all supported event types.
| hash< string, hash< DataProviderMessageInfo > > DataProvider::AbstractDataProvider::getEventTypesWithOptions | ( | *hash< auto > | options | ) |
Returns a hash of all supported event types in the context of the given options.
| INVALID-OPERATION | the data provider does not support the observer pattern / event API |
| hash< string, hash< DataProviderMessageInfo > > DataProvider::AbstractDataProvider::getEventTypesWithOptionsImpl | ( | *hash< auto > | options | ) |
Returns a hash of all supported event types in the context of the given options.
| options | option data that can be used to determine the final type |
| INVALID-OPERATION | the data provider does not support the observer pattern / event API |
| auto DataProvider::AbstractDataProvider::getExampleErrorResponseData | ( | string | error_code | ) |
Returns example data for the error message with the given error code.
| error_code | the error code for the response; must be a known error code, or an UNKNOWN-ERROR-RESPONSE exception is thrown |
| INVALID-OPERATION | the data provider does not support the request API |
| UNKNOWN-ERROR-RESPONSE | the error response given is not known |
| auto DataProvider::AbstractDataProvider::getExampleErrorResponseDataImpl | ( | string | error_code | ) |
Returns example data for the error message with the given error code.
| error_code | the error code for the response; must be a known error code, or an UNKNOWN-ERROR-RESPONSE exception is thrown |
| INVALID-OPERATION | the data provider does not support the request API |
| UNKNOWN-ERROR-RESPONSE | the error response given is not known |
| auto DataProvider::AbstractDataProvider::getExampleErrorResponseDataWithOptions | ( | string | error_code, |
| *hash< auto > | options | ||
| ) |
Returns example data for the error message with the given error code in the context of the given option data.
| error_code | the error code for the response; must be a known error code, or an UNKNOWN-ERROR-RESPONSE exception is thrown |
| options | option data that can be used to determine the final type |
| INVALID-OPERATION | the data provider does not support the request API |
| UNKNOWN-ERROR-RESPONSE | the error response given is not known |
| auto DataProvider::AbstractDataProvider::getExampleErrorResponseDataWithOptionsImpl | ( | string | error_code, |
| *hash< auto > | options | ||
| ) |
Returns example data for the error message with the given error code in the context of the given option data.
| options | action option data for the request |
| error_code | the error code for the response; must be a known error code, or an UNKNOWN-ERROR-RESPONSE exception is thrown |
| INVALID-OPERATION | the data provider does not support the request API |
| UNKNOWN-ERROR-RESPONSE | the error response given is not known |
| auto DataProvider::AbstractDataProvider::getExampleEventData | ( | string | event_id | ) |
Returns example data for the given observable event.
| event_id | the event ID of the event |
| INVALID-OPERATION | the data provider does not support the observer pattern / event API |
| INVALID-EVENT | the event_id is not valid |
| auto DataProvider::AbstractDataProvider::getExampleEventDataImpl | ( | string | event_id | ) |
Returns example data for the given observable event.
| event_id | the event ID of the event |
| INVALID-OPERATION | the data provider does not support the observer pattern / event API |
| INVALID-EVENT | the event_id is not valid |
| auto DataProvider::AbstractDataProvider::getExampleEventDataWithOptions | ( | string | event_id, |
| *hash< auto > | options | ||
| ) |
Returns example data for the given observable event in the context of the given option data.
| options | option data that can be used to determine the final type |
| event_id | the event ID of the event |
| INVALID-OPERATION | the data provider does not support the observer pattern / event API |
| INVALID-EVENT | the event_id is not valid |
| auto DataProvider::AbstractDataProvider::getExampleEventDataWithOptionsImpl | ( | string | event_id, |
| *hash< auto > | options | ||
| ) |
Returns example data for the given observable event in the context of the given option data.
| event_id | the event ID of the event |
| options | action option data |
| INVALID-OPERATION | the data provider does not support the observer pattern / event API |
| INVALID-EVENT | the event_id is not valid |
| hash< auto > DataProvider::AbstractDataProvider::getExampleRecordData | ( | ) |
Returns example data for the record type.
| hash< auto > DataProvider::AbstractDataProvider::getExampleRecordDataImpl | ( | ) |
Returns example data for the record type.
| hash< auto > DataProvider::AbstractDataProvider::getExampleRecordDataWithOptions | ( | *hash< auto > | options | ) |
Returns example data for the record type in the context of the given option data.
| options | option data that can be used to determine the final type |
| hash< auto > DataProvider::AbstractDataProvider::getExampleRecordDataWithOptionsImpl | ( | *hash< auto > | options | ) |
Returns example data for the record type in the context of the given option data.
| options | action option data |
| auto DataProvider::AbstractDataProvider::getExampleRequestData | ( | ) |
Returns example data for a request message.
| INVALID-OPERATION | the data provider does not support the request API |
| auto DataProvider::AbstractDataProvider::getExampleRequestDataImpl | ( | ) |
Returns example data for a request message.
| auto DataProvider::AbstractDataProvider::getExampleRequestDataWithOptions | ( | *hash< auto > | options | ) |
Returns example data for a request message in the context of the given option data.
| options | option data that can be used to determine the final type |
| INVALID-OPERATION | the data provider does not support the request API |
| auto DataProvider::AbstractDataProvider::getExampleRequestDataWithOptionsImpl | ( | *hash< auto > | options | ) |
Returns example data for a request message in the context of the given option data.
| options | action option data for the request |
| auto DataProvider::AbstractDataProvider::getExampleResponseData | ( | ) |
Returns example data for a successful request message.
| INVALID-OPERATION | the data provider does not support the request API |
| auto DataProvider::AbstractDataProvider::getExampleResponseDataImpl | ( | ) |
Returns example data for a successful request message.
| INVALID-OPERATION | the data provider does not support the request API |
| auto DataProvider::AbstractDataProvider::getExampleResponseDataWithOptions | ( | *hash< auto > | options | ) |
Returns example data for a successful request message in the context of the given option data.
| options | option data that can be used to determine the final type |
| INVALID-OPERATION | the data provider does not support the request API |
| auto DataProvider::AbstractDataProvider::getExampleResponseDataWithOptionsImpl | ( | *hash< auto > | options | ) |
Returns example data for a successful request message in the context of the given option data.
| options | action option data for the request |
| INVALID-OPERATION | the data provider does not support the request API |
|
static |
Returns an expression definition for an expression code or throws an exception.
| *hash< string, hash< DataProviderExpressionInfo > > DataProvider::AbstractDataProvider::getExpressionsWithOptions | ( | *hash< auto > | options | ) |
Returns supported expression in the context of the given option data.
| *hash< string, hash< DataProviderOptionInfo > > DataProvider::AbstractDataProvider::getFieldAddOptions | ( | ) |
Returns options that can be used for adding new fields to the data provider.
| *hash< string, hash< DataProviderOptionInfo > > DataProvider::AbstractDataProvider::getFieldDeleteOptions | ( | ) |
Returns options that can be used for deleting fields from the data provider.
| *hash< string, hash< DataProviderOptionInfo > > DataProvider::AbstractDataProvider::getFieldUpdateOptions | ( | ) |
Returns options that can be used for updating fields of the data provider.
| hash< auto > DataProvider::AbstractDataProvider::getInfoAsData | ( | *bool | with_type_info | ) |
Returns static provider information as data; no objects are returned.
| with_type_info | if True then more type information will be returned in the response |
name and children attributes are not returned as they are dynamic attributes | hash< DataProviderMessageInfo > DataProvider::AbstractDataProvider::getMessageInfo | ( | string | message_id | ) |
Returns the description of an outbound message, if any.
| message_id | the ID of the message |
| INVALID-OPERATION | the data provider does not support sending messages |
| INVALID-MESSAGE | the message_id is not valid |
| hash< DataProviderMessageInfo > DataProvider::AbstractDataProvider::getMessageInfoImpl | ( | string | message_id | ) |
Returns the type of an outbound message, if any.
| message_id | the ID of the message |
| INVALID-MESSAGE | the message is not supported by this data provider |
| string DataProvider::AbstractDataProvider::getMessageSupport | ( | ) |
Returns a code describing how the data provider supports sending messages.
| hash< string, hash< DataProviderMessageInfo > > DataProvider::AbstractDataProvider::getMessageTypes | ( | ) |
Returns a hash of all supported outbound messages.
| INVALID-OPERATION | the data provider does not support sending messages |
| hash< string, hash< DataProviderMessageInfo > > DataProvider::AbstractDataProvider::getMessageTypesImpl | ( | ) |
Returns a hash of all supported outbound messages.
| INVALID-OPERATION | the data provider does not support sending messages |
| hash< string, hash< DataProviderMessageInfo > > DataProvider::AbstractDataProvider::getMessageTypesWithOptions | ( | *hash< auto > | options | ) |
Returns a hash of all supported outbound messages with options.
| options | any action options that can affect the message types returned |
| INVALID-OPERATION | the data provider does not support sending messages |
| hash< string, hash< DataProviderMessageInfo > > DataProvider::AbstractDataProvider::getMessageTypesWithOptionsImpl | ( | *hash< auto > | options | ) |
Returns a hash of all supported outbound messages with options.
| options | any action options that can affect the message types returned |
| INVALID-OPERATION | the data provider does not support sending messages |
| AbstractDataProviderRecordIterator DataProvider::AbstractDataProvider::getRecordIterator | ( | *hash< auto > | search_options | ) |
Returns an iterator iterating all records.
| search_options | the search options; will be processed by validateSearchOptions() |
| INVALID-OPERATION | the data provider does not support reading |
| *hash< string, AbstractDataField > DataProvider::AbstractDataProvider::getRecordType | ( | *hash< auto > | search_options | ) |
Returns the description of the record type, if any.
| search_options | to be included and processed by validateSearchOptions() if recordRequiresSearchOptions() is True for this provider, otherwise any value provided in this argument is ignored |
| *hash< string, AbstractDataField > DataProvider::AbstractDataProvider::getRecordTypeImpl | ( | *hash< auto > | search_options | ) |
Returns the description of the record type, if any.
| search_options | any search options |
| *hash< string, AbstractDataField > DataProvider::AbstractDataProvider::getRecordTypeWithOptions | ( | *hash< auto > | options, |
| *hash< auto > | search_options | ||
| ) |
Returns the description of the record type in the context of the given options.
| options | action options that may influence the record type |
| search_options | to be included and processed by validateSearchOptions() if recordRequiresSearchOptions() is True for this provider, otherwise any value provided in this argument is ignored |
| *hash< string, AbstractDataField > DataProvider::AbstractDataProvider::getRecordTypeWithOptionsImpl | ( | *hash< auto > | options, |
| *hash< auto > | search_options | ||
| ) |
Returns the description of the record type in the context of the given options.
| options | action options that may influence the record type |
| search_options | to be included and processed by validateSearchOptions() if recordRequiresSearchOptions() is True for this provider, otherwise any value provided in this argument is ignored |
| *list< hash< AllowedValueInfo > > DataProvider::AbstractDataProvider::getReferenceData | ( | string | type, |
| *hash< auto > | action_opts | ||
| ) |
Returns reference data of the given kind if available.
| type | the unique type name of the reference data |
| action_opts | an optional hash of action options when called when working with an app action |
| REFERENCE-DATA-ERROR | thrown if there is an error retrieving the reference data |
| *list< hash< AllowedValueInfo > > DataProvider::AbstractDataProvider::getReferenceDataEx | ( | string | type, |
| *hash< auto > | action_opts | ||
| ) |
Returns reference data of the given kind if available.
| type | the unique type name of the reference data |
| action_opts | an optional hash of action options when called when working with an app action |
| REFERENCE-DATA-ERROR | thrown if there is an error retrieving the reference data |
| UNSUPPORTED-REFERENCE-DATA | thrown if type is not supported as reference data |
| *list< hash< AllowedValueInfo > > DataProvider::AbstractDataProvider::getReferenceDataSafe | ( | string | type, |
| *hash< auto > | action_opts | ||
| ) |
Returns reference data of the given kind if available; logs but ignores exceptions retrieving the data.
| type | the unique type name of the reference data |
| action_opts | an optional hash of action options when called when working with an app action |
| *list< hash< AllowedValueInfo > > DataProvider::AbstractDataProvider::getReferenceDataSafeEx | ( | string | type, |
| *hash< auto > | action_opts | ||
| ) |
Returns reference data of the given kind if available.
| type | the unique type name of the reference data |
| action_opts | an optional hash of action options when called when working with an app action |
Logs but ignores exceptions retrieving the data; throws an exception if the data type is unsupported
| UNSUPPORTED-REFERENCE-DATA | thrown if type is not supported as reference data |
| auto DataProvider::AbstractDataProvider::getReferenceDataValue | ( | string | type, |
| *hash< auto > | action_opts | ||
| ) |
Returns a reference data value of the given kind if available.
| type | the unique type name of the reference data |
| action_opts | an optional hash of action options when called when working with an app action |
| REFERENCE-DATA-ERROR | thrown if there is an error retrieving the reference data |
| auto DataProvider::AbstractDataProvider::getReferenceDataValueEx | ( | string | type, |
| *hash< auto > | action_opts | ||
| ) |
Returns a reference data value of the given kind if available.
| type | the unique type name of the reference data |
| action_opts | an optional hash of action options when called when working with an app action |
| REFERENCE-DATA-ERROR | thrown if there is an error retrieving the reference data |
| UNSUPPORTED-REFERENCE-DATA | thrown if type is not supported as reference data |
| auto DataProvider::AbstractDataProvider::getReferenceDataValueSafe | ( | string | type, |
| *hash< auto > | action_opts | ||
| ) |
Returns a reference data value of the given kind if available; logs but ignores exceptions retrieving the data.
| type | the unique type name of the reference data value |
| action_opts | an optional hash of action options when called when working with an app action |
| auto DataProvider::AbstractDataProvider::getReferenceDataValueSafeEx | ( | string | type, |
| *hash< auto > | action_opts | ||
| ) |
Returns reference data of the given kind if available.
| type | the unique type name of the reference data |
| action_opts | an optional hash of action options when called when working with an app action |
Logs but ignores exceptions retrieving the data; throws an exception if the data type is unsupported
| UNSUPPORTED-REFERENCE-DATA | thrown if type is not supported as reference data |
| *hash< string, hash< DataProviderOptionInfo > > DataProvider::AbstractDataProvider::getRequestOptions | ( | ) |
Returns options that can be used for requests.
| *AbstractDataProviderType DataProvider::AbstractDataProvider::getRequestType | ( | ) |
Returns the description of a successful request message, if any.
| INVALID-OPERATION | the data provider does not support the request API |
| *AbstractDataProviderType DataProvider::AbstractDataProvider::getRequestTypeImpl | ( | ) |
Returns the description of a successful request message, if any.
| *AbstractDataProviderType DataProvider::AbstractDataProvider::getRequestTypeWithData | ( | auto | req | ) |
Returns the description of a successful request message with call data, if any.
| req | sample request data that can be used to determine the final type |
| INVALID-OPERATION | the data provider does not support the request API |
| *AbstractDataProviderType DataProvider::AbstractDataProvider::getRequestTypeWithOptions | ( | *hash< auto > | options | ) |
Returns the description of a successful request message in the context of the given option data.
| options | action option data for the data provider |
| INVALID-OPERATION | the data provider does not support the request API |
| *AbstractDataProviderType DataProvider::AbstractDataProvider::getRequestTypeWithOptionsImpl | ( | *hash< auto > | options | ) |
Returns the description of a successful request message in the context of the given option data.
| options | action option data for the data provider |
| INVALID-OPERATION | the data provider does not support the request API |
| *AbstractDataProviderType DataProvider::AbstractDataProvider::getResponseType | ( | ) |
Returns the description of a response message, if this object represents a response message.
| INVALID-OPERATION | the data provider does not support the request API |
| *AbstractDataProviderType DataProvider::AbstractDataProvider::getResponseTypeImpl | ( | ) |
Returns the description of a response message, if this object represents a response message.
| *AbstractDataProviderType DataProvider::AbstractDataProvider::getResponseTypeWithData | ( | auto | req | ) |
Returns the description of a successful response message with call data, if any.
| req | sample request data that can be used to determine the final type |
| INVALID-OPERATION | the data provider does not support the request / response API |
| *AbstractDataProviderType DataProvider::AbstractDataProvider::getResponseTypeWithOptions | ( | *hash< auto > | options | ) |
Returns the description of a successful response message in the context of the given option data.
| options | action option data for the data provider |
| INVALID-OPERATION | the data provider does not support the request / response API |
| *AbstractDataProviderType DataProvider::AbstractDataProvider::getResponseTypeWithOptionsImpl | ( | *hash< auto > | options | ) |
Returns the description of a successful response message in the context of the given option data.
| options | action option data for the data provider |
| INVALID-OPERATION | the data provider does not support the request / response API |
| object DataProvider::AbstractDataProvider::getSchemaObject | ( | ) |
Returns the schema supporting this data provider.
| INVALID-OPERATION | thrown if the data provider does not support this API |
| object DataProvider::AbstractDataProvider::getSchemaObjectImpl | ( | ) |
Returns the schema object supporting this data provider.
| *object DataProvider::AbstractDataProvider::getSchemaType | ( | ) |
Returns the schema type for this data provider or NOTHING if no schema type is supported.
| *hash< auto > DataProvider::AbstractDataProvider::getSearchExpression | ( | *hash< auto > | where_cond, |
| *hash< auto > | search_options | ||
| ) |
Returns a search expression for a standard search hash.
| where_cond | the search criteria; if the data provider supports advanced search, and the value is an expression, it will be processed by processSearchParameters(), otherwise by processFieldValues() |
| search_options | the search options; will be processed by validateSearchOptions() |
| *hash< string, hash< DataProviderOptionInfo > > DataProvider::AbstractDataProvider::getSearchOptions | ( | ) |
Returns options that can be used for searching.
| *hash< string, hash< DataProviderOptionInfo > > DataProvider::AbstractDataProvider::getSendMessageOptions | ( | ) |
Returns options that can be used for sending messages from the data provider.
| *string DataProvider::AbstractDataProvider::getShortDesc | ( | ) |
Returns the data provider short description.
| *hash< string, AbstractDataField > DataProvider::AbstractDataProvider::getUpdateRecordType | ( | *hash< auto > | search_options | ) |
Returns the description of the record type for updating records, if any.
| search_options | to be included and processed by validateSearchOptions() if recordRequiresSearchOptions() is True for this provider, otherwise any value provided in this argument is ignored |
| *hash< string, AbstractDataField > DataProvider::AbstractDataProvider::getUpdateRecordTypeImpl | ( | *hash< auto > | search_options | ) |
Returns the description of the record type for updates, if any.
| search_options | any search options |
| *hash< string, AbstractDataField > DataProvider::AbstractDataProvider::getUpdateRecordTypeWithOptions | ( | *hash< auto > | options, |
| *hash< auto > | search_options | ||
| ) |
Returns the description of the record type for updating records in the context of the given options.
| options | action options that may influence the record type |
| search_options | to be included and processed by validateSearchOptions() if recordRequiresSearchOptions() is True for this provider, otherwise any value provided in this argument is ignored |
| *hash< string, AbstractDataField > DataProvider::AbstractDataProvider::getUpdateRecordTypeWithOptionsImpl | ( | *hash< auto > | options, |
| *hash< auto > | search_options | ||
| ) |
Returns the description of the record type for updating records in the context of the given options.
| options | action options that may influence the record type |
| search_options | to be included and processed by validateSearchOptions() if recordRequiresSearchOptions() is True for this provider, otherwise any value provided in this argument is ignored |
| *hash< string, hash< DataProviderOptionInfo > > DataProvider::AbstractDataProvider::getUpsertOptions | ( | ) |
Returns options that can be used for upserting records.
| hash< ActionOptionInfo > DataProvider::AbstractDataProvider::getWhereCondActionOption | ( | *hash< string, hash< DataProviderExpressionInfo > > | expressions | ) |
Returns an action where condition option in the context of the given option data.
| bool DataProvider::AbstractDataProvider::hasRecord | ( | ) |
| *hash< DataProviderExpression > DataProvider::AbstractDataProvider::processSearchParameters | ( | *hash< DataProviderExpression > | exp, |
| *hash< auto > | search_options | ||
| ) |
processes search parameter expressions
| exp | the expression to process |
| search_options | the search options after processing by validateSearchOptions() |
|
static |
Registers a child data provider if the data provider supports children and is extensible.
| name | the child's name |
| generator | code to generate the child; prototype: sub (string name, AbstractConnection conn) {} |
| UNSUPPORTED-ERROR | this exception is thrown by default, to support adding children, override this method |
| AbstractDataProviderRecordIterator DataProvider::AbstractDataProvider::requestSearchRecords | ( | *hash< auto > | search_options, |
| auto | req, | ||
| *hash< auto > | where_cond | ||
| ) |
Returns an iterator for zero or more records matching the search options according to an API request.
| req | the request to serialize and make according to the request type |
| where_cond | the search criteria; will be processed by processFieldValues() |
| search_options | the search options after processing by validateSearchOptions() |
This will execute the request and perform a default search on any record(s) returned
| INVALID-OPERATION | the data provider does not support reading records or the request / response API |
| AbstractDataProviderRecordIterator DataProvider::AbstractDataProvider::requestSearchRecords | ( | *hash< auto > | search_options, |
| auto | req, | ||
| *hash< DataProviderExpression > | where_cond | ||
| ) |
Returns an iterator for zero or more records matching the search options according to an API request.
| req | the request to serialize and make according to the request type |
| where_cond | the search criteria; will be processed by processFieldValues() |
| search_options | the search options after processing by validateSearchOptions() |
This will execute the request and perform a default search on any record(s) returned
| INVALID-OPERATION | the data provider does not support reading records or the request / response API |
| AbstractDataProviderRecordIterator DataProvider::AbstractDataProvider::requestSearchRecordsImpl | ( | *hash< auto > | search_options, |
| auto | req, | ||
| *hash< auto > | where_cond | ||
| ) |
Returns an iterator for zero or more records matching the search options according to an API request.
| req | the request to serialize and make according to the request type |
| where_cond | the search criteria; after processing by processSearchParameters() |
| search_options | the search options after processing by validateSearchOptions() |
This will execute the request and perform a default search on any record(s) returned
| bool DataProvider::AbstractDataProvider::requiresTransactionManagement | ( | ) |
Returns True if the data provider requires transaction management.
| void DataProvider::AbstractDataProvider::rollback | ( | ) |
Rolls back data written to the data provider.
Has no effect if the data provider does not support transaction management
| *hash< auto > DataProvider::AbstractDataProvider::searchFirstRecord | ( | hash< auto > | where_cond, |
| *hash< auto > | search_options | ||
| ) |
Returns the first record matching the search options.
| where_cond | the search criteria; will be processed by processFieldValues() |
| search_options | the search options; will be processed by validateSearchOptions() |
| INVALID-OPERATION | the data provider does not support reading |
| NO-DATA | the required_result search option was set and no record was found |
| *hash< auto > DataProvider::AbstractDataProvider::searchFirstRecord | ( | hash< DataProviderExpression > | where_cond, |
| *hash< auto > | search_options | ||
| ) |
Returns the first record matching the search options.
| where_cond | the search criteria; will be processed by processSearchParameters() |
| search_options | the search options; will be processed by validateSearchOptions() |
| INVALID-OPERATION | the data provider does not support reading |
| NO-DATA | the required_result search option was set and no record was found |
| *hash< auto > DataProvider::AbstractDataProvider::searchFirstRecordWithOptions | ( | *hash< auto > | options | ) |
Returns the first record matching the search action options.
| options | search action options |
| INVALID-OPERATION | the data provider does not support reading |
| NO-DATA | the required_result search option was set and no record was found |
| AbstractDataProviderRecordIterator DataProvider::AbstractDataProvider::searchRecords | ( | *hash< auto > | where_cond, |
| *hash< auto > | search_options | ||
| ) |
Returns an iterator for zero or more records matching the search options.
| where_cond | the search criteria; will be processed by processFieldValues() |
| search_options | the search options; will be processed by validateSearchOptions() |
| INVALID-OPERATION | the data provider does not support reading |
| AbstractDataProviderRecordIterator DataProvider::AbstractDataProvider::searchRecords | ( | *hash< DataProviderExpression > | where_cond, |
| *hash< auto > | search_options | ||
| ) |
Returns an iterator for zero or more records matching the search options.
| where_cond | the search criteria; will be processed by processSearchParameters() |
| search_options | the search options; will be processed by validateSearchOptions() |
| INVALID-OPERATION | the data provider does not support reading |
| AbstractDataProviderBulkRecordInterface DataProvider::AbstractDataProvider::searchRecordsBulk | ( | int | block_size, |
| *hash< auto > | search_options, | ||
| *hash< auto > | where_cond | ||
| ) |
Returns an iterator for zero or more records matching the search options.
| block_size | the number of records in a read block; must be a positive number |
| where_cond | the search criteria; will be processed by processFieldValues() |
| search_options | the search options; will be processed by validateSearchOptions() |
| INVALID-BLOCK-SIZE | the block size must be a positive number |
| INVALID-OPERATION | the data provider does not support reading |
| AbstractDataProviderBulkRecordInterface DataProvider::AbstractDataProvider::searchRecordsBulk | ( | int | block_size, |
| *hash< auto > | search_options, | ||
| *hash< DataProviderExpression > | where_cond | ||
| ) |
Returns an iterator for zero or more records matching the search options.
| block_size | the number of records in a read block; must be a positive number |
| where_cond | the search criteria; will be processed by processSearchParameters() |
| search_options | the search options; will be processed by validateSearchOptions() |
| INVALID-BLOCK-SIZE | the block size must be a positive number |
| INVALID-OPERATION | the data provider does not support reading |
| AbstractDataProviderBulkRecordInterface DataProvider::AbstractDataProvider::searchRecordsBulkImpl | ( | int | block_size, |
| *hash< auto > | search_options, | ||
| *hash< auto > | where_cond | ||
| ) |
Returns an iterator for zero or more records matching the search options.
| block_size | the number of records in a read block; must be a positive number |
| where_cond | the search criteria; after processing by processSearchParameters() |
| search_options | the search options after processing by validateSearchOptions() |
| INVALID-BLOCK-SIZE | the block size must be a positive number |
| INVALID-OPERATION | the data provider does not support reading |
| AbstractDataProviderBulkRecordInterface DataProvider::AbstractDataProvider::searchRecordsBulkWithOptions | ( | *hash< auto > | options | ) |
Returns an iterator for zero or more records matching the search action options.
| options | search action options |
| INVALID-BLOCK-SIZE | the block size must be a positive number |
| INVALID-OPERATION | the data provider does not support reading |
| AbstractDataProviderRecordIterator DataProvider::AbstractDataProvider::searchRecordsImpl | ( | *hash< auto > | where_cond, |
| *hash< auto > | search_options | ||
| ) |
Returns an iterator for zero or more records matching the search options.
| where_cond | the search criteria; after processing by processSearchParameters() |
| search_options | the search options after processing by validateSearchOptions() |
| AbstractDataProviderRecordIterator DataProvider::AbstractDataProvider::searchRecordsWithOptions | ( | *hash< auto > | options | ) |
Returns an iterator for zero or more records matching the search action options.
param options search action options
| INVALID-OPERATION | the data provider does not support reading |
| *hash< auto > DataProvider::AbstractDataProvider::searchSingleRecord | ( | *hash< auto > | where_cond, |
| *hash< auto > | search_options | ||
| ) |
Returns a single record matching the search options.
| where_cond | the search criteria; will be processed by processFieldValues() |
| search_options | the search options; will be processed by validateSearchOptions() |
| INVALID-OPERATION | the data provider does not support reading |
| MULTIPLE-RECORDS-ERROR | multiple records found |
| NO-DATA | the required_result search option was set and no record was found |
| *hash< auto > DataProvider::AbstractDataProvider::searchSingleRecord | ( | hash< DataProviderExpression > | where_cond, |
| *hash< auto > | search_options | ||
| ) |
Returns a single record matching the search options.
| where_cond | the search criteria; will be processed by processSearchParameters() |
| search_options | the search options; will be processed by validateSearchOptions() |
| INVALID-OPERATION | the data provider does not support reading |
| MULTIPLE-RECORDS-ERROR | multiple records found |
| NO-DATA | the required_result search option was set and no record was found |
| *hash< auto > DataProvider::AbstractDataProvider::searchSingleRecordWithOptions | ( | *hash< auto > | options | ) |
Returns a single record matching the search action options.
| options | search action options |
| INVALID-OPERATION | the data provider does not support reading |
| MULTIPLE-RECORDS-ERROR | multiple records found |
| NO-DATA | the required_result search option was set and no record was found |
| void DataProvider::AbstractDataProvider::sendMessage | ( | *hash< auto > | send_message_options, |
| string | message_id, | ||
| auto | msg | ||
| ) |
Sends a message from message-capable data providers.
| message_id | the message ID to send; must correspond to a valid message ID |
| msg | the message to send |
| send_message_options | the options for sending the message; processed by validateSendMessageOptions() |
| INVALID-OPERATION | thrown if the data provider does not support this API |
| INVALID-MESSAGE | the message_id is not valid |
| SEND-MESSAGE-ERROR | error sending the message |
| void DataProvider::AbstractDataProvider::sendMessageImpl | ( | *hash< auto > | send_message_options, |
| string | message_id, | ||
| auto | msg | ||
| ) |
Sends a message from message-capable data providers.
| message_id | the message ID to send; must correspond to a valid message ID |
| msg | the message to send |
| send_message_options | the options for sending the message |
| void DataProvider::AbstractDataProvider::setDebugCollector | ( | *AbstractDebugInfoCollector | collector | ) |
Sets the debug info collector for this data provider.
| collector | the debug collector to use, or NOTHING to disable debug collection |
When a debug collector is set, the data provider will call the collector's AbstractDebugInfoCollector::collect method with technical debug information about operations (HTTP requests, WebSocket messages, etc.).
|
static |
Ensures that no callbacks can be set for dynamic URI resolution.
|
static |
Set callbacks for dynamic URI resolution to allow for variable URI path elements to be resolved at runtime.
| value_needs_resolution | signature bool sub (string value) { ... }; this callback will be used to check if a URI path needs dynamic resolution |
| resolve_value | signature auto sub (auto value) { ... }; if value_needs_resolution returns True on a URI path, then this callback will be called at runtime for each request to resolve the URI path to the final path |
| bool DataProvider::AbstractDataProvider::supportsAddField | ( | ) |
Returns True if the data provider supports creating adding new fields.
| bool DataProvider::AbstractDataProvider::supportsChildren | ( | ) |
Returns True if the data provider supports children.
| bool DataProvider::AbstractDataProvider::supportsCreateChild | ( | ) |
Returns True if the data provider supports creating new child data providers.
| bool DataProvider::AbstractDataProvider::supportsDeleteChild | ( | ) |
Returns True if the data provider supports creating deleting child data providers.
| bool DataProvider::AbstractDataProvider::supportsDeleteField | ( | ) |
Returns True if the data provider supports deleting existing fields.
| bool DataProvider::AbstractDataProvider::supportsMessages | ( | ) |
Returns True if the data provider supports sending messages.
| bool DataProvider::AbstractDataProvider::supportsObservable | ( | ) |
Returns True if the data provider supports the observer pattern / event API.
| bool DataProvider::AbstractDataProvider::supportsSchema | ( | ) |
Returns True if the data provider supports a schema.
| bool DataProvider::AbstractDataProvider::supportsSearchExpressions | ( | ) |
Returns True if the data provider supports advanced search expressions.
| bool DataProvider::AbstractDataProvider::supportsUpdateField | ( | ) |
Returns True if the data provider supports updating existing fields.
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsForCreateWithOptions | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data for a create action.
| action | action info for the upsert action |
| options | sample option data that can be used to determine the final type |
| INVALID-OPERATION | the data provider does not support record creation |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsForCreateWithOptionsImpl | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data for a create action.
| action | action info for the upsert action |
| options | sample option data that can be used to determine the final type |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsForDeleteWithOptions | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data for a delete action.
| action | action info for the event action |
| options | sample option data that can be used to determine the final type |
| INVALID-OPERATION | the data provider does not support record deletion |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsForDeleteWithOptionsImpl | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data for a delete action.
| action | action info for the delete action |
| options | sample option data that can be used to determine the final type |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsForEventWithOptions | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data for an event action.
| action | action info for the request action |
| options | sample option data that can be used to determine the final type |
| INVALID-OPERATION | the data provider does not support the observer pattern / event API |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsForEventWithOptionsImpl | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data for an event action.
| action | action info for the request action |
| options | sample option data that can be used to determine the final type |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsForMessageWithOptions | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data for a send message action.
| action | action info for the search action |
| options | sample option data that can be used to determine the final type |
| INVALID-OPERATION | the data provider does not support sending messages |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsForMessageWithOptionsImpl | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data for a send message action.
| action | action info for the search action |
| options | sample option data that can be used to determine the final type |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsForRequestWithOptions | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data for a request action.
| action | action info for the send message action |
| options | sample option data that can be used to determine the final type |
| INVALID-OPERATION | the data provider does not support the request API |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsForRequestWithOptionsImpl | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data for a request action.
| action | action info for the send message action |
| options | sample option data that can be used to determine the final type |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsForSearchWithOptions | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data for a search action.
| action | action info for the create action |
| options | sample option data that can be used to determine the final type |
| INVALID-OPERATION | the data provider does not support reading |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsForSearchWithOptionsImpl | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data for a search action.
| action | action info for the create action |
| options | sample option data that can be used to determine the final type |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsForUpdateWithOptions | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data for an update action.
| action | action info for the delete action |
| options | sample option data that can be used to determine the final type |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsForUpdateWithOptionsImpl | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data for an update action.
| action | action info for the delete action |
| options | sample option data that can be used to determine the final type |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsForUpsertWithOptions | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data for an upsert action.
| action | action info for the update action |
| options | sample option data that can be used to determine the final type |
| INVALID-OPERATION | the data provider does not support record upserting |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsForUpsertWithOptionsImpl | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data for an upsert action.
| action | action info for the update action |
| options | sample option data that can be used to determine the final type |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsFromRequestTypeWithData | ( | auto | req | ) |
Returns action options corresponding to the request type with the given request data, if possible.
| req | sample request data that can be used to determine the final type |
| INVALID-OPERATION | the data provider does not support the request API |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsWithOptions | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data.
| action | action info for the event action |
| options | sample option data that can be used to determine the final type |
| *hash< string, hash< ActionOptionInfo > > DataProvider::AbstractDataProvider::tryGetActionOptionsWithOptionsImpl | ( | hash< DataProviderActionInfo > | action, |
| *hash< auto > | options | ||
| ) |
Returns action options corresponding to the given option data.
| action | action info to determine options |
| options | sample option data that can be used to determine the final type |
| void DataProvider::AbstractDataProvider::updateField | ( | *hash< auto > | field_update_options, |
| string | name, | ||
| AbstractDataField | field | ||
| ) |
Updates an existing field.
| name | the name of the current field to update |
| field | the new definition of the field |
| field_update_options | the options for adding the new field |
| INVALID-OPERATION | thrown if the data provider does not support this API |
| UPDATE-FIELD-ERROR | error adding the field |
| void DataProvider::AbstractDataProvider::updateFieldImpl | ( | *hash< auto > | field_update_options, |
| string | name, | ||
| AbstractDataField | field | ||
| ) |
Updates an existing field.
| name | the name of the current field to update |
| field | the new definition of the field |
| field_update_options | the options for adding the new field |
| int DataProvider::AbstractDataProvider::updateRecords | ( | *hash< auto > | search_options, |
| hash< auto > | set, | ||
| *hash< auto > | where_cond | ||
| ) |
Updates zero or more records matching the search options.
| set | the hash of field data to set |
| where_cond | a hash for identifying the record(s) to be updated; will be processed by processFieldValues() |
| search_options | the search options; will be processed by validateSearchOptions() |
| INVALID-OPERATION | the data provider does not support record updating |
| UPDATE-RECORDS-ERROR | error updating records |
| int DataProvider::AbstractDataProvider::updateRecords | ( | *hash< auto > | search_options, |
| hash< auto > | set, | ||
| *hash< DataProviderExpression > | where_cond | ||
| ) |
Updates zero or more records matching the search options.
| set | the hash of field data to set |
| where_cond | a hash for identifying the record(s) to be updated; will be processed by processSearchParameters() |
| search_options | the search options; will be processed by validateSearchOptions() |
| INVALID-OPERATION | the data provider does not support record updating |
| UPDATE-RECORDS-ERROR | error updating records |
| int DataProvider::AbstractDataProvider::updateRecordsImpl | ( | *hash< auto > | search_options, |
| hash< auto > | set, | ||
| *hash< auto > | where_cond | ||
| ) |
Updates zero or more records matching the search options.
| set | the hash of field data to set |
| where_cond | a hash for identifying the record(s) to be updated |
| search_options | the update options after processing by validateSearchOptions() |
| int DataProvider::AbstractDataProvider::updateRecordsWithOptions | ( | *hash< auto > | options | ) |
Updates zero or more records matching the update action options.
| options | update action options |
| INVALID-OPERATION | the data provider does not support record updating |
| UPDATE-RECORDS-ERROR | error updating records |
| bool DataProvider::AbstractDataProvider::updateSingleRecord | ( | *hash< auto > | search_options, |
| hash< auto > | set, | ||
| hash< auto > | where_cond | ||
| ) |
Updates a single record matching the search options.
| set | the hash of field data to set; will be processed by processFieldValues() |
| where_cond | the search criteria; will be processed by processFieldValues() |
| search_options | the search options; will be processed by validateSearchOptions() |
| INVALID-OPERATION | the data provider does not support record updating |
| UPDATE-RECORDS-ERROR | error updating records |
| bool DataProvider::AbstractDataProvider::updateSingleRecord | ( | *hash< auto > | search_options, |
| hash< auto > | set, | ||
| hash< DataProviderExpression > | where_cond | ||
| ) |
Updates a single record matching the search options.
| set | the hash of field data to set; will be processed by processFieldValues() |
| where_cond | the search criteria; will be processed by processSearchParameters() |
| search_options | the search options; will be processed by validateSearchOptions() |
| INVALID-OPERATION | the data provider does not support record updating |
| UPDATE-RECORDS-ERROR | error updating records |
| bool DataProvider::AbstractDataProvider::updateSingleRecordImpl | ( | *hash< auto > | search_options, |
| hash< auto > | set, | ||
| hash< auto > | where_cond | ||
| ) |
Updates a single record matching the search options.
| set | the hash of field data to set |
| where_cond | the search criteria |
| search_options | the search options after processing by validateSearchOptions() |
| bool DataProvider::AbstractDataProvider::updateSingleRecordWithOptions | ( | *hash< auto > | options | ) |
Updates a single record using update action options.
| options | update action options |
| INVALID-OPERATION | the data provider does not support record updating |
| UPDATE-RECORDS-ERROR | error updating records |
| string DataProvider::AbstractDataProvider::upsertRecord | ( | hash< auto > | rec, |
| *hash< auto > | upsert_options | ||
| ) |
Upserts the given record in the data provider.
| rec | a hash representing a single input record |
| upsert_options | the upsert options; will be processed by validateUpsertOptions() |
| INVALID-OPERATION | the data provider does not support upsert operations |
| string DataProvider::AbstractDataProvider::upsertRecordImpl | ( | hash< auto > | rec, |
| *hash< auto > | upsert_options | ||
| ) |
Upserts the given record to the data provider.
| rec | a hash representing a single input record |
| upsert_options | the create options after processing by validateUpsertOptions() |
| *list< string > DataProvider::AbstractDataProvider::upsertRecordsBulk | ( | AbstractDataProviderBulkRecordInterface | stream, |
| *hash< auto > | upsert_options | ||
| ) |
Upserts the given records in the data provider.
| stream | a record stream for upserting records |
| upsert_options | the upsert options; will be processed by validateUpsertOptions() |
| INVALID-OPERATION | the data provider does not support upsert operations |
| *list< string > DataProvider::AbstractDataProvider::upsertRecordsBulk | ( | hash< auto > | recs, |
| *hash< auto > | upsert_options | ||
| ) |
Upserts the given records in the data provider.
| recs | a hash representing multiple input records, where the keys are field names and values are either lists of field values or a single value that applies to all records to be upserted |
| upsert_options | the upsert options; will be processed by validateUpsertOptions() |
| INVALID-OPERATION | the data provider does not support upsert operations |
| *list< string > DataProvider::AbstractDataProvider::upsertRecordsBulk | ( | HashListIterator | i, |
| *hash< auto > | upsert_options | ||
| ) |
Upserts the given records in the data provider.
| i | a record iterator for upserting records |
| upsert_options | the upsert options; will be processed by validateUpsertOptions() |
| INVALID-OPERATION | the data provider does not support upsert operations |
| *list< string > DataProvider::AbstractDataProvider::upsertRecordsBulk | ( | list< auto > | recs, |
| *hash< auto > | upsert_options | ||
| ) |
Creates the given records in the data provider.
| recs | a list of hashes representing input records, where the keys are field names and values are field values |
| upsert_options | the upsert options; will be processed by validateUpsertOptions() |
| INVALID-OPERATION | the data provider does not support upsert operations |
| *list< string > DataProvider::AbstractDataProvider::upsertRecordsBulkImpl | ( | hash< auto > | recs, |
| *hash< auto > | upsert_options | ||
| ) |
Upserts the given records in the data provider.
| recs | a hash representing multiple input records, where the keys are field names and values are either lists of field values or a single value that applies to all records to be upserted |
| upsert_options | the upsert options; will be processed by validateUpsertOptions() |
| *list< string > DataProvider::AbstractDataProvider::upsertRecordsBulkWithOptions | ( | *hash< auto > | options | ) |
Upserts the given records in the data provider from upsert action options.
| options | upsert action options |
| INVALID-OPERATION | the data provider does not support upsert operations |
| string DataProvider::AbstractDataProvider::upsertRecordWithOptions | ( | *hash< auto > | options | ) |
Upserts the given record in the data provider from upsert action options.
| options | upsert action options |
| INVALID-OPERATION | the data provider does not support upsert operations |
| *hash< auto > DataProvider::AbstractDataProvider::validateChildCreateOptions | ( | *hash< auto > | child_create_options | ) |
validates child create options
| CHILD-CREATE-OPTION-ERROR | invalid or unsupported child create option |
| *hash< auto > DataProvider::AbstractDataProvider::validateChildDeleteOptions | ( | *hash< auto > | child_delete_options | ) |
validates child delete options
| CHILD-DELETE-OPTION-ERROR | invalid or unsupported child delete option |
| *hash< auto > DataProvider::AbstractDataProvider::validateCreateOptions | ( | *hash< auto > | create_options | ) |
validates create options
| CREATE-OPTION-ERROR | invalid or unsupported create option |
| *hash< auto > DataProvider::AbstractDataProvider::validateFieldAddOptions | ( | *hash< auto > | field_add_options | ) |
validates field add options
| FIELD-ADD-OPTION-ERROR | invalid or unsupported field add option |
| *hash< auto > DataProvider::AbstractDataProvider::validateFieldDeleteOptions | ( | *hash< auto > | field_delete_options | ) |
validates field delete options
| FIELD-DELETE-OPTION-ERROR | invalid or unsupported field delete option |
| *hash< auto > DataProvider::AbstractDataProvider::validateFieldUpdateOptions | ( | *hash< auto > | field_update_options | ) |
validates field update options
| FIELD-UPDATE-OPTION-ERROR | invalid or unsupported field update option |
| *hash< auto > DataProvider::AbstractDataProvider::validateRequestOptions | ( | *hash< auto > | request_options | ) |
validates request options
| REQUEST-OPTION-ERROR | invalid or unsupported request option |
| *hash< auto > DataProvider::AbstractDataProvider::validateSearchOptions | ( | *hash< auto > | search_options | ) |
validates search options
| SEARCH-OPTION-ERROR | invalid or unsupported search option |
| *hash< auto > DataProvider::AbstractDataProvider::validateSendMessageOptions | ( | *hash< auto > | send_message_options | ) |
validates send message options
| SEND-MESSAGE-OPTION-ERROR | invalid or unsupported send message option |
| *hash< auto > DataProvider::AbstractDataProvider::validateUpsertOptions | ( | *hash< auto > | upsert_options | ) |
validates upsert options
| UPSERT-OPTION-ERROR | invalid or unsupported upsert option |
|
static |
processes an expression in a certain context
| role | the role of the operation being performed |
| expmap | the map of supported expressions for this data provider |
| caps | the logic capabilities supported by the data provider for the current operation |
| expected_type | the type the expression should be compatible with |
| exp | the expression to process |
| DATA-PROVIDER-EXPRESSION-ERROR | the expression has an error; argument mismatch, type error, etc |
|
static |
processes an expression in a certain context
| role | the role of the operation being performed |
| caps | the logic capabilities supported by the data provider for the current operation |
| expinfo | the expression being processed |
| values | the values / arguments for the expression |
| pos | the position in the argument list |