Qore ServiceNowRestDataProvider Module Reference  1.0.1
ServiceNowRestDataProvider::ServiceNowTableDataProvider Class Reference

The ServiceNowTableDataProvider data provider class. More...

Inheritance diagram for ServiceNowRestDataProvider::ServiceNowTableDataProvider:

Public Member Methods

 constructor (ServiceNowRestClient rest, string name, hash< auto > access, hash< auto > meta)
 Creates the object from the arguments.
 
string getName ()
 Returns the data provider name.
 

Public Attributes

hash< auto > access
 access description
 
hash< auto > meta
 metadata description
 
string name
 current object name
 
ServiceNowRestClient::ServiceNowRestClient rest
 The REST client object for API calls.
 
const SysColumns = ...
 system columns
 

Private Member Methods

*hash< auto > createRecordImpl (hash< auto > rec, *hash< auto > create_options)
 Creates the given record to the data provider. More...
 
int deleteRecordsImpl (*hash< auto > where_cond, *hash< auto > search_options)
 Deletes zero or more records. More...
 
 deleteSingleRecord (string id)
 deletes a single record
 
 getRecordInfoIntern ()
 Retrieves the record type.
 
hash< DataProvider::DataProviderInfogetStaticInfoImpl ()
 Returns data provider static info.
 
hash< ServiceNowRestRecordInforecord_info ()
 Record info for the table.
 
DataProvider::AbstractDataProviderRecordIterator searchRecordsImpl (*hash< auto > where_cond, *hash< auto > search_options)
 Returns an iterator for zero or more records matching the search options. More...
 
int updateRecordsImpl (hash< auto > set, hash< auto > where_cond, *hash< auto > search_options)
 Updates zero or more records matching the search options. More...
 
 updateSingleRecord (string id, hash< auto > set)
 updates a single record
 

Private Attributes

string uri_path = "table/"
 URI path prefix.
 

Detailed Description

The ServiceNowTableDataProvider data provider class.

Member Function Documentation

◆ createRecordImpl()

*hash<auto> ServiceNowRestDataProvider::ServiceNowTableDataProvider::createRecordImpl ( hash< auto >  rec,
*hash< auto >  create_options 
)
private

Creates the given record to the data provider.

Parameters
reca hash representing a single input record
create_optionsthe create options after processing by validateCreateOptions()
Returns
the data written to the data provider with the "id" field of the new record
Exceptions
DUPLICATE-RECORDthis exception should be thrown if the provider fails due to an attempt to create a duplicate record

◆ deleteRecordsImpl()

int ServiceNowRestDataProvider::ServiceNowTableDataProvider::deleteRecordsImpl ( *hash< auto >  where_cond,
*hash< auto >  search_options 
)
private

Deletes zero or more records.

Parameters
where_conda hash for identifying the record(s) to be deleted
search_optionsthe delete options after processing by validateSearchOptions()
Returns
the number of records deleted

◆ searchRecordsImpl()

DataProvider::AbstractDataProviderRecordIterator ServiceNowRestDataProvider::ServiceNowTableDataProvider::searchRecordsImpl ( *hash< auto >  where_cond,
*hash< auto >  search_options 
)
private

Returns an iterator for zero or more records matching the search options.

Parameters
where_condthe search criteria
search_optionsthe search options after processing by validateSearchOptions()
See also
requestSearchRecordsImpl()

◆ updateRecordsImpl()

int ServiceNowRestDataProvider::ServiceNowTableDataProvider::updateRecordsImpl ( hash< auto >  set,
hash< auto >  where_cond,
*hash< auto >  search_options 
)
private

Updates zero or more records matching the search options.

Parameters
setthe hash of field data to set
where_conda hash for identifying the record(s) to be updated
search_optionsthe update options after processing by validateSearchOptions()
Returns
the number of records updated