A dumrequest data provider that provides an empty hash as the request and response types.
More...
|
|
| constructor (*hash< auto > options) |
| | Creates the object.
|
| |
|
*string | getDesc () |
| | Returns the data provider description.
|
| |
|
string | getName () |
| | Returns the name of this data provider ("NullRequest")
|
| |
|
hash< DataProviderInfo > | getStaticInfoImpl () |
| | Returns data provider static info.
|
| |
| | addField (AbstractDataField field, *hash< auto > field_add_options) |
| | Creates a new field.
|
| |
| | beginTransaction () |
| | Begins a transaction with a data provider.
|
| |
| | checkAddField () |
| | Ensures that the data provider supports adding fields.
|
| |
| | checkCreate () |
| | Ensures that the data provider supports record creation.
|
| |
| | checkCreateChild () |
| | Ensures that the data provider supports creating children.
|
| |
| | checkDelete () |
| | Ensures that the data provider supports record deletion.
|
| |
| | checkDeleteChild () |
| | Ensures that the data provider supports deleting children.
|
| |
| | checkDeleteField () |
| | Ensures that the data provider supports deleting fields.
|
| |
| | checkMessages () |
| | Ensures that the data provider supports sending messages.
|
| |
| | checkObservable () |
| | Ensures that the data provider supports observer pattern / event API.
|
| |
| | checkRead () |
| | Ensures that the data provider supports read operations.
|
| |
| | checkRequest () |
| | Ensures that the data provider supports the request API.
|
| |
| | checkSchema () |
| | Ensures that the data provider supports a schema.
|
| |
| | checkSearchExpressions () |
| | Ensures that the data provider supports advanced search expressions.
|
| |
| | checkUpdate () |
| | Ensures that the data provider supports record upserts.
|
| |
| | checkUpdateField () |
| | Ensures that the data provider supports updating fields.
|
| |
| | checkUpsert () |
| | Ensures that the data provider supports record upserts.
|
| |
| | commit () |
| | Commits data written to the data provider.
|
| |
|
| constructor () |
| | Creates the data provider.
|
| |
|
| constructor (LoggerInterface logger) |
| | Creates the data provider with the given Logger.
|
| |
| AbstractDataProvider | createChildProvider (string name, hash< string, AbstractDataField > fields, *hash< auto > child_create_options) |
| | 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.
|
| |
| | deleteChildProvider (string name, *hash< auto > child_delete_options) |
| | Deletes a child data provider.
|
| |
| | deleteField (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.
|
| |
| auto | doRequest (auto req, *hash< auto > request_options) |
| | Makes a request and returns the response.
|
| |
| *hash< auto > | getAdditionalInfo () |
| | Returns additional provider-specific information.
|
| |
| AbstractDataProviderBulkOperation | getBulkInserter () |
| | Returns a bulk insert operation object for the data provider.
|
| |
| AbstractDataProviderBulkRecordInterface | getBulkRecordInterface (int block_size=1000, *hash< auto > search_options) |
| | Returns an iterator iterating all records with the bulk read API.
|
| |
| AbstractDataProviderBulkOperation | getBulkUpserter () |
| | Returns a bulk upsert operation object for the data provider.
|
| |
| *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.
|
| |
| *list< hash< DataProviderSummaryInfo > > | getChildProviderSummaryInfo () |
| | Return data provider summary info.
|
| |
| *hash< DataProviderConnectionInfo > | getConnectionInfo () |
| | Returns connection info if the data provider supports connections, otherwise returns NOTHING.
|
| |
|
*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.
|
| |
| 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< DataProviderMessageInfo > | getEventInfo (string event_id) |
| | Returns the description of an observable event, if any.
|
| |
| hash< DataProviderMessageInfo > | getEventInfoWithData (string event_id, auto req) |
| | 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.
|
| |
| auto | getExampleErrorResponseData (string error_code) |
| | Returns example data for the error message with the given error code.
|
| |
| auto | getExampleEventData (string event_id) |
| | Returns example data for the given observable event.
|
| |
| hash< auto > | getExampleRecordData () |
| | Returns example data for the record type.
|
| |
| auto | getExampleRequestData () |
| | Returns example data for a request message.
|
| |
| auto | getExampleResponseData () |
| | Returns example data for a successful request message.
|
| |
|
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< string, hash< MapperRuntimeKeyInfo > > | getMapperRuntimeKeys () |
| | Returns custom data mapper runtime keys.
|
| |
| hash< DataProviderMessageInfo > | getMessageInfo (string message_id) |
| | Returns the description of an outbound message, if any.
|
| |
| hash< string, hash< DataProviderMessageInfo > > | getMessageTypes () |
| | Returns a hash of all supported outbound messages.
|
| |
| AbstractDataProviderRecordIterator | getRecordIterator (*hash< auto > search_options) |
| | Returns an iterator iterating all records.
|
| |
| *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.
|
| |
| *AbstractDataProviderType | getRequestType () |
| | 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 | getResponseType () |
| | 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.
|
| |
| object | getSchemaObject () |
| | Returns the schema supporting this data provider.
|
| |
| *hash< auto > | getSearchExpression (*hash< auto > where_cond, *hash< auto > search_options) |
| | Returns a search expression for a standard search hash.
|
| |
| *string | getShortDesc () |
| | Returns the data provider short description.
|
| |
|
hash< DataProviderSummaryInfo > | getSummaryInfo () |
| | Return data provider summary info.
|
| |
| *hash< string, bool > | getSupportedElementReferenceData () |
| | Returns information on supported element reference data.
|
| |
| *hash< string, bool > | getSupportedReferenceData () |
| | Returns information on supported reference data.
|
| |
| *hash< string, bool > | getSupportedReferenceDataValues () |
| | Returns information on supported reference data values.
|
| |
| AbstractDataProviderRecordIterator | requestSearchRecords (auto req, *hash< auto > where_cond, *hash< auto > search_options) |
| | Returns an iterator for zero or more records matching the search options according to an API request.
|
| |
| AbstractDataProviderRecordIterator | requestSearchRecords (auto req, *hash< DataProviderExpression > where_cond, *hash< auto > search_options) |
| | 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.
|
| |
| | rollback () |
| | Rolls back data written to the data provider.
|
| |
| *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.
|
| |
| 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=1000, *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=1000, *hash< auto > where_cond, *hash< auto > search_options) |
| | Returns an iterator for zero or more records matching the search 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.
|
| |
| | sendMessage (string message_id, auto msg, *hash< auto > send_message_options) |
| | Sends a message from message-capable data providers.
|
| |
| *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 > > | tryGetActionOptionsWithData (hash< DataProviderActionInfo > action, auto req) |
| | Returns action options corresponding to the given option data.
|
| |
| | updateConnectionObjects (object conn, object connobj) |
| | Update any connection used by the data provider.
|
| |
| | updateField (string name, AbstractDataField field, *hash< auto > field_update_options) |
| | Updates an existing field.
|
| |
| int | updateRecords (hash< auto > set, *hash< auto > where_cond, *hash< auto > search_options) |
| | Updates zero or more records matching the search options.
|
| |
| int | updateRecords (hash< auto > set, *hash< DataProviderExpression > where_cond, *hash< auto > search_options) |
| | Updates zero or more records matching the search options.
|
| |
| bool | updateSingleRecord (hash< auto > set, hash< auto > where_cond, *hash< auto > search_options) |
| | Updates a single record matching the search options.
|
| |
| bool | updateSingleRecord (hash< auto > set, hash< DataProviderExpression > where_cond, *hash< auto > search_options) |
| | Updates a single record matching the search options.
|
| |
| string | upsertRecord (hash< auto > rec, *hash< auto > upsert_options) |
| | Upserts the given record in the data provider.
|
| |