com.wrq.vhi.script.api
Interface ModelRecord

All Superinterfaces:

Record

public interface ModelRecord
extends Record

A record in a ModelRecordSet. The names of the columns are the names of the fields in the underlying model record set.

Method Summary

int	getIndex() Gets the index assigned to this record by the model.
TerminalAttributes	getTerminalAttributes(int index) Gets the terminal attributes by column index.
TerminalAttributes	getTerminalAttributes(java.lang.String field) Gets the terminal attributes by field name.
boolean	isBlank() Checks if the record is considered blank.
boolean	isExcluded() Checks if the record is excluded.

Methods inherited from interface com.wrq.vhi.script.api.Record

get, get, getCount, getName, getNames, indexOf

Method Detail

isBlank

boolean isBlank()

Checks if the record is considered blank. Blank records are often used for direct record inserts.

Returns:

True if the record is considered blank

isExcluded

boolean isExcluded()

Checks if the record is excluded. Excluded records are not visible to client applications. Often, blank and repeated records are excluded.

Returns:

True if the record is excluded

getIndex

int getIndex()

Gets the index assigned to this record by the model. This is not the row number in parent ModelRecordSet object. In fact, the record indices are likely not contiguous.

Returns:

The one-based recordset record index

getTerminalAttributes

TerminalAttributes getTerminalAttributes(java.lang.String field)
                                         throws java.lang.IllegalArgumentException

Gets the terminal attributes by field name.

Parameters:

field - the field name

Returns:

the TerminalAttributes of the first cell in the field

Throws:

java.lang.IllegalArgumentException - if the field name is invalid

getTerminalAttributes

TerminalAttributes getTerminalAttributes(int index)
                                         throws java.lang.IllegalArgumentException

Gets the terminal attributes by column index.

Parameters:

index - the column index

Returns:

the terminal attributes of the first cell in the field

Throws:

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