com.wrq.vhi.script.api

Interface ScriptHostSession

All Superinterfaces:

HostSession

public interface ScriptHostSession
extends HostSession

Provides information about the scripted host session and allows for the manipulation of the terminal at various levels (direct, model, table).

Field Summary

Fields inherited from interface com.wrq.vhi.script.api.HostSession

ANY_COLUMN, ANY_ROW, CURRENT_COLUMN, CURRENT_ROW, DESIGN_TOOL_AND_SERVER, DESIGN_TOOL_ONLY, DONT_WAIT_FOR_ECHO, LINEAR_REGION, RECTANGULAR_REGION, SCROLL_END, SCROLL_HOME, SCROLL_LINE_DOWN, SCROLL_LINE_UP, SCROLL_PAGE_DOWN, SCROLL_PAGE_UP, SYNC_TO_HOST, WAIT_FOR_CURSOR_AUTOTAB, WAIT_FOR_CURSOR_MOVE, WAIT_FOR_ECHO_BEHIND_CURSOR, WAIT_FOR_ECHO_SAME_NUMBER, WAIT_FOR_ECHO_TAB_OR_BEHIND_CURSOR

Method Summary

Modifier and Type	Method and Description
void	connectToHost() Connects to the host.
void	disconnectFromHost() Disconnects from the host.
void	executeLogin() Executes the login command list.
void	executeLogout() Executes the logout command list.
int	getHostSessionID() Gets the VHI host session ID.
java.lang.Object	getHostStateObject(java.lang.String name) Gets the object bound to the specified name in this host session, or null if no object is bound to the name.
boolean	isHostStateObject(java.lang.String name) Tests for the presence of a host state object bound to the specified name.
void	setHostStateObject(java.lang.String name, java.lang.Object object) Binds an object to this host session, using the name specified.

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

checkOperationConditions, defaultValue, executeCommandList, executeOperation, executeSQLStatement, executeTableProcedure, fetchRecords, getAttribute, getAttributeAtCursor, getAttributeMetaData, getAttributeRegion, getAttributeRegions, getAttributes, getAttributes, getColumnMetaData, getCurrentEntity, getCurrentRecord, getCurrentRecordIndex, getCurrentRecordSet, getCursorPosition, getEntityAttributes, getEntityDescription, getEntityOperations, getEntityRecordSets, getFieldMetaData, getFieldRegion, getFieldRegions, getHomeEntity, getLinearTerminalRegion, getModelEntities, getModelVariable, getModelVariableNames, getModelVariables, getOperationMetaData, getPatternRegion, getPatternRegions, getProcedureMetaData, getRecordRegion, getRecordSetMetaData, getRecordSetRegion, getRectangularTerminalRegion, getStringAtCursor, getStringAtLocation, getStringAtOffset, getTableColumns, getTableDescription, getTableNames, getTableProcedures, getTerminalScreen, getTerminalScreenSize, getVariableMetaData, insertRecord, insertRecords, moveCurrentRecordIndex, moveCursor, navigate, nextRecord, readFromMappedAttribute, readVariableFromAttribute, readVariableFromField, readVariableFromLocation, readVariableFromTerminal, resetRecordSet, selectCurrentRecord, selectRecordByFilter, selectRecordByIndex, setAttribute, setAttributeDelayed, setAttributes, setAttributesDelayed, setCurrentEntity, setCurrentRecordIndex, setCurrentRecordSet, setModelVariable, setModelVariables, shiftCursor, transmit, transmit, transmitTerminalKey, transmitToAttribute, transmitToField, transmitToLocation, transmitToLocation, transmitToOffset, transmitToOffset, updateAttribute, updateAttributes, updateAttributes, updateCurrentRecord, updateRecordByFilter, updateRecordByIndex, updateRecords, updateRecordSetField, updateRecordSetFields, updateRecordSetFields, wait, waitForCommString, waitForCommString, waitForCondition, waitForCursorAtAttribute, waitForCursorAtLocation, waitForCursorAtRecordSetField, waitForCursorAtTerminalField, waitForCursorNotAtLocation, waitForCursorNotAtTerminalField, waitForDisplayString, waitForEntities, waitForEntity, waitForHostData, waitForHostSilence, waitForKeyboardEnabled, waitForMultipleEvents, waitForNewHostScreen, waitForUpdate, waitMS, writeToMappedAttribute, writeVariableToAttribute, writeVariableToField, writeVariableToLocation, writeVariableToTerminal

Method Detail

getHostSessionID

int getHostSessionID()

Gets the VHI host session ID.

Returns:

host session ID

connectToHost

void connectToHost()
            throws ApptrieveException

Connects to the host. Upon returning from this method a connection will have been established with the host, but the login command list will not have been executed.

Throws:

ApptrieveException

disconnectFromHost

void disconnectFromHost()
                 throws ApptrieveException

Disconnects from the host. Calling this method immediately drops the connection without navigating home and without executing the logout command list.

Throws:

ApptrieveException

executeLogin

void executeLogin()
           throws ApptrieveException

Executes the login command list.

Throws:

ApptrieveException

executeLogout

void executeLogout()
            throws ApptrieveException

Executes the logout command list.

Throws:

ApptrieveException

isHostStateObject

boolean isHostStateObject(java.lang.String name)

Tests for the presence of a host state object bound to the specified name.

Parameters:

name - the name of the object

Returns:

true if an object is bound to the specified name

getHostStateObject

java.lang.Object getHostStateObject(java.lang.String name)

Gets the object bound to the specified name in this host session, or null if no object is bound to the name.

Parameters:

name - the name of the object

Returns:

the object bound to the specified name or null if none

setHostStateObject

void setHostStateObject(java.lang.String name,
                        java.lang.Object object)

Binds an object to this host session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.

Parameters:

name - the name to which to bind the object

object - the object to bind