MapQuest Advantage JavaScript API Reference Documentation

Class MQRecordSet

Object
   |
   +--MQObject
         |
         +--MQRecordSet

class MQRecordSet
extends MQObject


Class for retrieving record attribute information.
See:

Defined in mqobjects.js


Field Summary
<private>  Boolean m_BOF
          Value to represent beginning of file indicator
<private>  int m_curRec
          Value to represent current record
<private>  Boolean m_EOF
          Value to represent end of file indicator
<private>  MQStringCollection m_Fields
          Value to represent the field names of the columns
<private>  int m_recCnt
          Value to represent total record count
<private>  MQStrColCollection m_Records
          Value to represent the record set retrieved for the user
   
Fields inherited from class MQObject
m_xmlDoc, m_xpath
 
Constructor Summary
MQRecordSet ()
            Constructs a new MQRecordSet object.
 
Method Summary
 String getClassName()
           Returns the text name of this class.
 String getField(<String> strFieldName)
           Get the field value by field name
 MQStringCollection getFieldNames()
           Get the list of available field names
 int getObjectVersion()
           Returns the version of this class.
 Boolean isBOF()
           Set to true when the cursor is before the beginning of the record set
 Boolean isEOF()
           Set to true when the cursor is passed the end of the record set
 void loadXml(<String> strXml)
           Assigns the xml that relates to this object.
 void moveFirst()
           Sets the cursor to the first record in the record set.
 void moveLast()
           Sets the cursor to the last record in the record set.
 void moveNext()
           Sets the cursor to the next record in the record set.
 String saveXml()
           Build an xml string that represents this object.
 
Methods inherited from class MQObject
getM_XmlDoc, setM_XmlDoc, getM_Xpath, setM_Xpath, setProperty, getProperty, copy, internalCopy
 

Field Detail

m_BOF

<private> Boolean m_BOF

m_curRec

<private> int m_curRec

m_EOF

<private> Boolean m_EOF

m_Fields

<private> MQStringCollection m_Fields

m_recCnt

<private> int m_recCnt

m_Records

<private> MQStrColCollection m_Records

Constructor Detail

MQRecordSet

MQRecordSet()

Method Detail

getClassName

String getClassName()

getField

String getField(<String> strFieldName)

getFieldNames

MQStringCollection getFieldNames()

getObjectVersion

int getObjectVersion()

isBOF

Boolean isBOF()

isEOF

Boolean isEOF()

loadXml

void loadXml(<String> strXml)

moveFirst

void moveFirst()

moveLast

void moveLast()

moveNext

void moveNext()

saveXml

String saveXml()

MapQuest Advantage JavaScript API Reference Documentation

Documentation generated by JSDoc on Tue Oct 16 08:04:12 2007