Defines the record iterator class for Table-based iterators.
More...
#include <CdsRestRecordIterator.qc.dox.h>
Inherits AbstractDataProviderRecordIterator.
Defines the record iterator class for Table-based iterators.
◆ constructor()
creates the iterator
- Parameters
-
rest | the REST client connection |
name | the name of the entity |
record_info | record information describing the entity |
where_cond | the where clause for the query, if any |
search_options | search options; assumed to have already been processed for validity before this call |
◆ getRecordType()
Returns the record description, if available.
- Returns
- the record type of the iterator
◆ getValue()
hash< auto > CdsRestDataProvider::CdsRestRecordIterator::getValue |
( |
| ) |
|
Returns a single record if the iterator is valid.
- Exceptions
-
INVALID-ITERATOR | the iterator is not pointing at a valid element |
◆ memberGate()
auto CdsRestDataProvider::CdsRestRecordIterator::memberGate |
( |
string |
key | ) |
|
Returns the value of the given field in the current row, if the iterator is valid.
- Parameters
-
- Returns
- the value of the given field in the current row, if the iterator is valid
- Exceptions
-
FIELD-ERROR | invalid or unknown field name |
◆ next()
bool CdsRestDataProvider::CdsRestRecordIterator::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 CdsRestDataProvider::CdsRestRecordIterator::valid |
( |
| ) |
|
Returns True if the iterator is valid.
- Returns
- True if the iterator is valid