com.wrq.vhi.script.api

Interface RecordSet

All Known Subinterfaces:

ModelRecordSet, MutableProcedureRecordSet, ProcedureRecordSet, RecordSetScreen

public interface RecordSet

A table of data. Rows, represented by Record objects, can be accessed by a zero-based index.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List	getColumnNames() Gets an immutable list of column names.
int	getCount() Gets the number of records in the record set.
Record	getRecord(int row) Gets a record by row number.
java.lang.String	toXMLString() Gets an XML string representation of the recordset.

Method Detail

getCount

int getCount()

Gets the number of records in the record set.

Returns:

the number of records

getRecord

Record getRecord(int row)
                 throws java.lang.IllegalArgumentException

Gets a record by row number.

Parameters:

row - the zero-based row number

Returns:

the record for the specified row

Throws:

java.lang.IllegalArgumentException - if the row index is invalid

getColumnNames

java.util.List getColumnNames()

Gets an immutable list of column names.

Returns:

an immutable list of column names.

toXMLString

java.lang.String toXMLString()
                             throws ApptrieveException

Gets an XML string representation of the recordset.

Returns:

an XML string

Throws:

ApptrieveException