com.wrq.vhi.script.api

Interface HostSessionEvent

All Superinterfaces:

Event, ModelEvent

All Known Subinterfaces:

ApplyFilterEvent, AttributeEvent, ClientConnectedEvent, ClientDisconnectedEvent, EntityArrivalEvent, EntityMoveCursorEvent, ExecuteLoginEvent, ExecuteLogoutEvent, ExecuteOperationEvent, ExecuteProcedureEvent, FieldEvent, GetCurrentHostRecordEvent, GetRecordTypeEvent, InsertRecordEvent, IsTerminatedEvent, ModelCursorEvent, ModelMoveCursorBackwardEvent, ModelMoveCursorEvent, ModelMoveCursorForwardEvent, ParseRecordEvent, ParseScreenEvent, ProcessStringEvent, ReadAttributeEvent, ReadFieldEvent, RecordEvent, RecordSetEvent, UnrecognizedScreenEvent, UpdateRecordEvent, WriteAttributeEvent, WriteAttributesEvent, WriteFieldEvent

public interface HostSessionEvent
extends ModelEvent

Host session event information.

Method Summary

Modifier and Type	Method and Description
ScriptHostSession	getHostSession() Gets the host session associated with this event.

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

getHostSession

ScriptHostSession getHostSession()

Gets the host session associated with this event. This provides information about the host session and allows for the manipulation of the terminal. The ScriptHostSession interface must only be used within the event that obtained it. No reference to the interface should exist upon returning from the event.

Returns:

the host session