com.wrq.vhi.script.api
Interface RecordSetEvent

All Superinterfaces:

EntityEvent, Event, HostSessionEvent, ModelEvent

All Known Subinterfaces:

ApplyFilterEvent, FieldEvent, GetCurrentHostRecordEvent, GetRecordTypeEvent, InsertRecordEvent, IsTerminatedEvent, ParseRecordEvent, ParseScreenEvent, ReadFieldEvent, RecordEvent, UpdateRecordEvent, WriteFieldEvent

public interface RecordSetEvent
extends EntityEvent, HostSessionEvent

Record set event information.

Method Summary

int	getPageNumber() Gets the one-based page number of the recordset at the time the event fired.
RecordSetContext	getRecordSetContext() Gets the record set context.
RecordSetMetaData	getRecordSetMetaData() Gets the metadata for this recordset.
java.lang.String	getRecordSetName() Gets the record set name.

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

getRecordSetName

java.lang.String getRecordSetName()

Gets the record set name.

Returns:

the name of the record set

getPageNumber

int getPageNumber()

Gets the one-based page number of the recordset at the time the event fired. The page number is one plus the number of times scrolled down minus the number of times scrolled up.

If no scrolling has occurred, the recordset is considered to be on the first page. After paging down once, the recordset is considered to be on the second page.

If the recordset is paged up while on the first page, the state of the recordset is reset and the counting starts over again. Thus the page number will always be greater than or equal to one.

Returns:

The one-based page number of the recordset

getRecordSetContext

RecordSetContext getRecordSetContext()

Gets the record set context. The record set context can be used to preserve state information between events.

Returns:

the record set context

getRecordSetMetaData

RecordSetMetaData getRecordSetMetaData()
                                       throws ApptrieveException

Gets the metadata for this recordset.

Returns:

the metadata for the recordset

Throws:

ApptrieveException - if an error occurs obtaining the metadata