Qore ServiceNowRestDataProvider Module Reference 1.2.1
Loading...
Searching...
No Matches
ServiceNowRestDataProvider::ServiceNowRestRecordIterator Class Reference

Defines the record iterator class for Table-based iterators. More...

#include <ServiceNowRestRecordIterator.qc.dox.h>

Inherits AbstractDataProviderRecordIterator.

Public Member Methods

 constructor (ServiceNowRestClient::ServiceNowRestClient rest, string name, hash< ServiceNowRestRecordInfo > record_info, *hash< auto > where_cond, *hash< auto > search_options)
 creates the iterator More...
 
*hash< string, DataProvider::AbstractDataFieldgetRecordType ()
 Returns the record description, if available. More...
 
hash< auto > getValue ()
 Returns a single record if the iterator is valid. More...
 
*string makeQuery (*hash< DataProviderExpression > where_cond, *hash< auto > search_options)
 Returns the filter for a request.
 
auto memberGate (string key)
 Returns the value of the given field in the current row, if the iterator is valid. More...
 
bool next ()
 Increments the row pointer when retrieving rows from a select statement; returns True if there is a row to retrieve, False if not. More...
 
bool valid ()
 Returns True if the iterator is valid. More...
 

Private:Internal Attributes

Qore::ListHashIterator i
 record iterator
 
string name
 current object name
 
hash< ServiceNowRestRecordInforecord_info
 Record info for the entity.
 
ServiceNowRestClient::ServiceNowRestClient rest
 The REST client object for API calls.
 

Detailed Description

Defines the record iterator class for Table-based iterators.

Member Function Documentation

◆ constructor()

ServiceNowRestDataProvider::ServiceNowRestRecordIterator::constructor ( ServiceNowRestClient::ServiceNowRestClient  rest,
string  name,
hash< ServiceNowRestRecordInfo record_info,
*hash< auto >  where_cond,
*hash< auto >  search_options 
)

creates the iterator

Parameters
restthe REST client connection
namethe name of the entity
record_inforecord information describing the entity
where_condthe where clause for the query, if any
search_optionssearch options; assumed to have already been processed for validity before this call

◆ getRecordType()

*hash< string, DataProvider::AbstractDataField > ServiceNowRestDataProvider::ServiceNowRestRecordIterator::getRecordType ( )

Returns the record description, if available.

Returns
the record type of the iterator

◆ getValue()

hash< auto > ServiceNowRestDataProvider::ServiceNowRestRecordIterator::getValue ( )

Returns a single record if the iterator is valid.

Exceptions
INVALID-ITERATORthe iterator is not pointing at a valid element

◆ memberGate()

auto ServiceNowRestDataProvider::ServiceNowRestRecordIterator::memberGate ( string  key)

Returns the value of the given field in the current row, if the iterator is valid.

Parameters
keythe name of the field
Returns
the value of the given field in the current row, if the iterator is valid
Exceptions
FIELD-ERRORinvalid or unknown field name

◆ next()

bool ServiceNowRestDataProvider::ServiceNowRestRecordIterator::next ( )

Increments the row pointer when retrieving rows from a select statement; returns True if there is a row to retrieve, False if not.

Returns
True if there is a row to retrieve, False if not (no more rows to be retrieved)
Note
Exceptions could be thrown by the DBI driver when the statement is executed; see the relevant DBI driver docs for more information

◆ valid()

bool ServiceNowRestDataProvider::ServiceNowRestRecordIterator::valid ( )

Returns True if the iterator is valid.

Returns
True if the iterator is valid