com.wrq.vhi.script.api
Interface GetCurrentHostRecordEvent

All Superinterfaces:

EntityEvent, Event, HostSessionEvent, ModelEvent, RecordSetEvent

public interface GetCurrentHostRecordEvent
extends RecordSetEvent

Get current host record event information.

See Also:

RecordSetEventHandler.getCurrentHostRecord(com.wrq.vhi.script.api.GetCurrentHostRecordEvent)

Method Summary

int	defaultGetCurrentHostRecord() Gets the index of the record that the VHI has determined as the current host record.
RecordSetScreen	getCurrentRecordSetScreen() Fetches all records (including blank, repeated, filtered etc) on the current screen.

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

getCurrentRecordSetScreen

RecordSetScreen getCurrentRecordSetScreen()
                                          throws ApptrieveException

Fetches all records (including blank, repeated, filtered etc) on the current screen.

Returns:

the records on the current screen

Throws:

ApptrieveException

defaultGetCurrentHostRecord

int defaultGetCurrentHostRecord()

Gets the index of the record that the VHI has determined as the current host record.

Returns:

the one-based index of the current host record