com.wrq.vhi.script.api

Interface ModelEvent

All Superinterfaces:

Event

All Known Subinterfaces:

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

public interface ModelEvent
extends Event

Model event information.

Method Summary

Modifier and Type	Method and Description
ClientSession	getClientSession() Gets the client session.
java.lang.String	getCurrentOperation() Gets the name of the currently running operation.
java.lang.String	getCurrentProcedure() Gets the name of the currently running procedure.
ModelContext	getModelContext() Gets the model context.

Methods inherited from interface com.wrq.vhi.script.api.Event

checkForTimeout, createErrorMessage, createErrorMessage, createHostSession, createUserErrorMessage, getEventStack, getHandlerProperty, getLogger, isDesignEnvironment

Method Detail

getCurrentOperation

java.lang.String getCurrentOperation()

Gets the name of the currently running operation.

Returns:

the name of the currently running operation or an empty string if none

getCurrentProcedure

java.lang.String getCurrentProcedure()

Gets the name of the currently running procedure.

Returns:

the name of the currently running procedure or an empty string if none

getModelContext

ModelContext getModelContext()

Gets the model context. This provides information about the model for the event.

Returns:

the model context

getClientSession

ClientSession getClientSession()

Gets the client session. This provides information about the currently connected client. If no client is connected this method will return null.

Returns:

the client session or null if no client is connected