com.wrq.vhi.script.api
Interface ErrorReportedEvent

All Superinterfaces:

Event, ModelEvent

public interface ErrorReportedEvent
extends ModelEvent

Error reported event information.

See Also:

ModelEventHandler.errorReported(com.wrq.vhi.script.api.ErrorReportedEvent)

Method Summary

CursorPosition	getCursorPosition() Gets the current position of the cursor on the terminal screen.
ErrorMessage	getErrorMessage() Gets the error reported.
RectangularTerminalRegion	getTerminalScreen() Gets the size and contents of the terminal screen.

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

getErrorMessage

ErrorMessage getErrorMessage()

Gets the error reported.

Returns:

the error reported

getTerminalScreen

RectangularTerminalRegion getTerminalScreen()
                                            throws ApptrieveException

Gets the size and contents of the terminal screen.

Returns:

the contents of the entire terminal screen

Throws:

ApptrieveException

getCursorPosition

CursorPosition getCursorPosition()
                                 throws ApptrieveException

Gets the current position of the cursor on the terminal screen.

Returns:

the cursor position

Throws:

ApptrieveException