com.wrq.vhi.script.api

Interface IsTerminatedEvent

All Superinterfaces:

EntityEvent, Event, HostSessionEvent, ModelEvent, RecordSetEvent

public interface IsTerminatedEvent
extends RecordSetEvent

Is terminated event information.

See Also:

RecordSetEventHandler.isTerminated(com.wrq.vhi.script.api.IsTerminatedEvent)

Field Summary

Fields

Modifier and Type	Field and Description
static int	SCROLL_DOWN Constant that specifies VHI is checking for scroll down termination.
static int	SCROLL_UP Constant that specifies VHI is checking for scroll up termination.

Method Summary

Modifier and Type	Method and Description
boolean	defaultIsTerminated() Gets the result of VHI's default termination logic as defined in the model.
RecordSetScreen	getCurrentRecordSetScreen() Fetches all records (including blank, repeated, filtered etc) on the current screen.
int	getScrollDirection() Gets the direction VHI is checking for scroll termination.

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

SCROLL_UP

static final int SCROLL_UP

Constant that specifies VHI is checking for scroll up termination.

SCROLL_DOWN

static final int SCROLL_DOWN

Constant that specifies VHI is checking for scroll down termination.

Method Detail

getScrollDirection

int getScrollDirection()

Gets the direction VHI is checking for scroll termination.

Returns:

one of the following constants:

• SCROLL_UP
• SCROLL_DOWN

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

defaultIsTerminated

boolean defaultIsTerminated()

Gets the result of VHI's default termination logic as defined in the model.

Returns:

true if VHI determined that scrolling is terminated