com.wrq.vhi.script.api
Interface GetRecordTypeEvent

All Superinterfaces:

EntityEvent, Event, HostSessionEvent, ModelEvent, RecordEvent, RecordSetEvent

public interface GetRecordTypeEvent
extends RecordEvent

Get record type event information.

See Also:

RecordSetEventHandler.getRecordType(com.wrq.vhi.script.api.GetRecordTypeEvent)

Field Summary

static int	BLANK_RECORD Record type constant that means the record does not contain data but is still visible to client applications.
static int	EXCLUDED_BLANK_RECORD Record type constant that means the record does not contain data and is not visible to client applications.
static int	EXCLUDED_RECORD Record type constant that means the record should not be visible to client applications.
static int	NORMAL_RECORD Record type constant that means the record contains data and is visible to client applications.

Method Summary

int	defaultGetRecordType() Gets the default record type of the record.
int	getLastHostRecordIndex() Gets the one-based index of the last record on the screen.
ModelRecord	getRecord() Get the record.
boolean	isLastPage() Check if this is the last page of the record set.

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

getHostRecordIndex, getRecordIndex, getRecordStateObject, isRecordStateObject, setRecordStateObject

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

getPageNumber, getRecordSetContext, getRecordSetMetaData, getRecordSetName

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

getEntityName, getTabStops

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

getHostSession

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

getClientSession, getCurrentOperation, getCurrentProcedure, getModelContext

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

checkForTimeout, createErrorMessage, createErrorMessage, createHostSession, createUserErrorMessage, getEventStack, getHandlerProperty, getLogger, isDesignEnvironment

Field Detail

NORMAL_RECORD

static final int NORMAL_RECORD

Record type constant that means the record contains data and is visible to client applications.

BLANK_RECORD

static final int BLANK_RECORD

Record type constant that means the record does not contain data but is still visible to client applications. Blank records are often used for direct record inserts. When an insert occurs on a record of this type it will automatically become a NORMAL_RECORD record.

EXCLUDED_RECORD

static final int EXCLUDED_RECORD

Record type constant that means the record should not be visible to client applications. Typically this type is used for repeated records and records that contain no data and cannot be used for insertions.

EXCLUDED_BLANK_RECORD

static final int EXCLUDED_BLANK_RECORD

Record type constant that means the record does not contain data and is not visible to client applications. This is the combination of BLANK_RECORD and EXCLUDED_RECORD. When an insert occurs on a record of this type it will automatically become a NORMAL_RECORD record.

Method Detail

getRecord

ModelRecord getRecord()

Get the record.

Returns:

the record

isLastPage

boolean isLastPage()

Check if this is the last page of the record set.

Returns:

true if this page was determined to be the last

getLastHostRecordIndex

int getLastHostRecordIndex()

Gets the one-based index of the last record on the screen. This is the index of the record within the current screen, not the index of the record within the recordset. This is the same as the number of records on the page.

Returns:

the one-based host record index of the last record on the page

defaultGetRecordType

int defaultGetRecordType()

Gets the default record type of the record. This is the default as defined by the model. The type of record affects whether or not a client application can see the record and if the record might be eligible for an insert.

Returns:

one of the following constants:

• NORMAL_RECORD
• BLANK_RECORD
• EXCLUDED_RECORD
• EXCLUDED_BLANK_RECORD