com.wrq.vhi.script.api
Interface RecordEvent

All Superinterfaces:

EntityEvent, Event, HostSessionEvent, ModelEvent, RecordSetEvent

All Known Subinterfaces:

ApplyFilterEvent, FieldEvent, GetRecordTypeEvent, ParseRecordEvent, ReadFieldEvent, WriteFieldEvent

public interface RecordEvent
extends RecordSetEvent

Record event information.

Method Summary

int	getHostRecordIndex() Gets the one-based index of this record on the screen.
int	getRecordIndex() Gets the one-based index of the record within the recordset.
java.lang.Object	getRecordStateObject(java.lang.String name) Gets the object bound to the specified name in this record set context, or null if no object is bound to the name.
boolean	isRecordStateObject(java.lang.String name) Tests for the presence of a record set context object bound to the specified name.
void	setRecordStateObject(java.lang.String name, java.lang.Object object) Binds an object to this record set context, using the name specified.

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.ModelEvent

getClientSession, getCurrentOperation, getCurrentProcedure, getModelContext

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

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

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

Method Detail

getRecordIndex

int getRecordIndex()

Gets the one-based index of the record within the recordset.

Returns:

the one-based record index

getHostRecordIndex

int getHostRecordIndex()

Gets the one-based index of this 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 method will return one for the first record of every screen in the recordset.

Returns:

the one-based host record index

isRecordStateObject

boolean isRecordStateObject(java.lang.String name)

Tests for the presence of a record set context object bound to the specified name.

Parameters:

name - the name of the object

Returns:

true if an object is bound to the specified name

getRecordStateObject

java.lang.Object getRecordStateObject(java.lang.String name)

Gets the object bound to the specified name in this record set context, or null if no object is bound to the name.

Parameters:

name - the name of the object

Returns:

the object bound to the specified name or null if none

setRecordStateObject

void setRecordStateObject(java.lang.String name,
                          java.lang.Object object)

Binds an object to this record set context, using the name specified. If an object of the same name is already bound to the record set context, the object is replaced.

Parameters:

name - the name to which to bind the object

object - the object to bind