com.wrq.vhi.script.api
Interface RecordSetScreen

All Superinterfaces:
ModelRecordSet, RecordSet

public interface RecordSetScreen
extends ModelRecordSet

A record set that describes the contents of the current screen. This record set includes all records, including blank and repeated records.


Method Summary
 TerminalRegion getRecordRegion(int row)
          Gets the rectangular region which describes the location, size and contents of the record.
 RectangularTerminalRegion getRecordSetRegion()
          Gets the rectangular screen region which describes the location, size and contents of the recordset.
 
Methods inherited from interface com.wrq.vhi.script.api.ModelRecordSet
getModelRecord
 
Methods inherited from interface com.wrq.vhi.script.api.RecordSet
getColumnNames, getCount, getRecord, toXMLString
 

Method Detail

getRecordSetRegion

RectangularTerminalRegion getRecordSetRegion()
Gets the rectangular screen region which describes the location, size and contents of the recordset.

Returns:
the location, size and contents of the recordset

getRecordRegion

TerminalRegion getRecordRegion(int row)
                               throws java.lang.IllegalArgumentException
Gets the rectangular region which describes the location, size and contents of the record.

Parameters:
row - the row number
Returns:
the record region.
Throws:
java.lang.IllegalArgumentException - if the row index is invalid