com.ibm.eNetwork.HOD.common.cached Interface LoadableJSAppletInterface


Overview	Package	Class	Tree	Serialized	Deprecated	Index	Help	API User's Guide

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

public interface LoadableJSAppletInterface

LoadableJSAppletInterface provides an optional mechanism to access the caching management of Z and I Emulator for Web specific libraries provided by the Z and I Emulator for Web server and to provide access to the applet via Java Script.

A custom applet, implementing this interface and launched via com.ibm.eNetwork.HOD.cached.appletloader.JSCachedAppletLoader in a Deployment Wizard derived HTML, can specify automatic caching management of the required Z and I Emulator for Web specific libraries.

In contrast the custom applet libraries themselves will be downloaded and temporarily cached in the browser.


Method Summary
`java.lang.String`	`callCustomerFunction (java.lang.String fncName, java.lang.String parms)` Method which can be used to extend the API to provide additional functionality.
`int`	`connectSession ()` Method called to cause a session to initiate the connection.
`int`	`connectSession1 (java.lang.String sessionName)` Method called to cause a session specified by the sessionName to initiate the connection.
`int`	`disconnectSession ()` Method called to cause a session to disconnect.
`int`	`disconnectSession1 (java.lang.String sessionName)` Method called to cause the session specified by the sessionName to disconnect.
`int`	`displaySession ()` Method to display the currently selected session.
`int`	`displaySession1 (java.lang.String sessionName)` Method to display the session specified by the sessionName.
`java.lang.String`	`getAllSessionNames ()` Method which can be used to return a list of all active sessions.
`java.lang.String`	`getErrorMessage ()` Method which can be used to receive any error messages
`java.lang.String`	`getSessionID ()` Method which can be used to return the ID of the last session started by startSession.
`java.lang.String`	`getString ()` Method which can be used to retrieve data from a session.
`java.lang.String`	`getString1 (java.lang.String sessionName)` Method which can be used to retrieve data from the session specified by sessionName
`java.lang.String`	`getString3 (java.lang.String sessionName, int pos, int length)` Method which can be used to retrieve data from the session specified by sessionName
`java.lang.String`	`getString4 (java.lang.String sessionName, int row, int col, int length)` Method which can be used to retrieve data from the session specified by sessionName at the specified position.
`int`	`getStringLength ()` Method which can be used to return the number of characters copied into the last getString() call.
`int`	`hideDesktop ()` Method to hide the desktop.
`void`	`init ()` Called by JSCachedAppletLoader to inform this LoadableJSAppletInterface instance that it has been loaded into the system.
`int`	`inputInhibited ()` Method which can be used to check whether the currently selected session is ready for interaction, such as sending keystrokes or calling other API methods
`int`	`inputInhibited1 (java.lang.String sessionName)` Method which can be used to check whether the specified session is ready for interaction, such as sending keystrokes or calling other API methods
`boolean`	`isCommReady ()` Method which can be used to check whether the currently selected session is ready to communicate with the host.
`boolean`	`isCommReady1 (java.lang.String sessionName)` Method which can be used to check whether the specified session is ready to communicate with the host.
`boolean`	`isSessionActive (java.lang.String sessionName)` Method which can be used to determine if the specified session is active.
`int`	`reset ()` Method which can be used to rest the currently selected session's locked keyboard
`int`	`reset1 (java.lang.String sessionName)` Method which can be used to rest the specified sessions locked keyboard
`int`	`sendKeys1 (java.lang.String text)` Method which can be used to send a string of keys to a session.
`int`	`sendKeys2 (java.lang.String sessionName, java.lang.String text)` Method which can be used to send a string of keys to a session specified by sessionName
`int`	`sendKeys3 (java.lang.String sessionName, java.lang.String text, int pos)` Method which can be used to send a string of keys to a session specified by sessionName at the specified cursor location.
`int`	`sendKeys4 (java.lang.String sessionName, java.lang.String text, int row, int col)` Method which can be used to send a string of keys to a session specified by sessionName at the specified row and column.
`void`	`setApplet (java.applet.Applet a)` Called by CachedAppletLoader to pass a reference to itself to this LoadableAppletInterface instance.
`int`	`setString1 (java.lang.String text)` Method which can be used to send a string of keys to a session.
`int`	`setString2 (java.lang.String sessionName, java.lang.String text)` Method which can be used to send a string of keys to a session specified by sessionName
`int`	`setString3 (java.lang.String sessionName, java.lang.String text, int pos)` Method which can be used to send a string of keys to a session specified by sessionName at the specified cursor location.
`int`	`setString4 (java.lang.String sessionName, java.lang.String text, int row, int col)` Method which can be used to send a string of keys to a session specified by sessionName at the specified row and column.
`int`	`showDesktop ()` Method to show the desktop.
`void`	`start ()` Called by JSCachedAppletLoader to inform this LoadableJSAppletInterface instance that it should start its execution.
`int`	`startMacro1 (java.lang.String macroName)` Method which can be used to start a macro on the current session.
`int`	`startMacro2 (java.lang.String sessionName, java.lang.String macroName)` Method which can be used to start a macro on the specified session
`int`	`startSession (java.lang.String sessionName)` Method which can be used to start the session specified
`void`	`stop ()` Called by JSCachedAppletLoader to inform this LoadableJSAppletInterface instance that the stop method has been called.
`int`	`stopAllSessions ()` Method called to stop all active sessions
`int`	`stopSession ()` Method called to stop a session
`int`	`stopSession1 (java.lang.String sessionName)` Method called to stop a particular session specified by the sessionName
`int`	`waitForStringInRect8 (java.lang.String text, int sRow, int sCol, int eRow, int eCol, long timeout, boolean waitForInput, boolean caseSensitive)` Method which can be used to synchronously wait until the input text string appears at the given rectangle in the currently selected session
`int`	`waitForStringInRect9 (java.lang.String sessionName, java.lang.String text, int sRow, int sCol, int eRow, int eCol, long timeout, boolean waitForInput, boolean caseSensitive)` Method which can be used to synchronously wait until the input text string appears at the given rectangle in the session specified by sessionName.
`int`	`waitWhileStringInRect8 (java.lang.String text, int sRow, int sCol, int eRow, int eCol, long timeout, boolean waitForInput, boolean caseSensitive)` Method which can be used to synchronously wait until the input text string is no longer in the given rectangle in the currently selected session.
`int`	`waitWhileStringInRect9 (java.lang.String sessionName, java.lang.String text, int sRow, int sCol, int eRow, int eCol, long timeout, boolean waitForInput, boolean caseSensitive)` Method which can be used to synchronously wait until the input text string is no longer in the given rectangle in the session specified by sessionName.


Method Detail

setApplet



public void 
setApplet(java.applet.Applet a)

start



public void 
start()

init



public void 
init()

stop



public void 
stop()

startSession



public int 
startSession(java.lang.String sessionName)

getSessionID



public java.lang.String 
getSessionID()

getAllSessionNames



public java.lang.String 
getAllSessionNames()

stopSession



public int 
stopSession()

stopSession1



public int 
stopSession1(java.lang.String sessionName)

stopAllSessions



public int 
stopAllSessions()

connectSession



public int 
connectSession()

connectSession1



public int 
connectSession1(java.lang.String sessionName)

disconnectSession



public int 
disconnectSession()

disconnectSession1



public int 
disconnectSession1(java.lang.String sessionName)

displaySession



public int 
displaySession()

displaySession1



public int 
displaySession1(java.lang.String sessionName)

hideDesktop



public int 
hideDesktop()

showDesktop



public int 
showDesktop()

sendKeys1



public int 
sendKeys1(java.lang.String text)

sendKeys2



public int 
sendKeys2(java.lang.String sessionName,
                     java.lang.String text)

sendKeys3



public int 
sendKeys3(java.lang.String sessionName,
                     java.lang.String text,
                     int pos)

sendKeys4



public int 
sendKeys4(java.lang.String sessionName,
                     java.lang.String text,
                     int row,
                     int col)

setString1



public int 
setString1(java.lang.String text)

setString2



public int 
setString2(java.lang.String sessionName,
                      java.lang.String text)

setString3



public int 
setString3(java.lang.String sessionName,
                      java.lang.String text,
                      int pos)

setString4



public int 
setString4(java.lang.String sessionName,
                      java.lang.String text,
                      int row,
                      int col)

getString



public java.lang.String 
getString()

getString1



public java.lang.String 
getString1(java.lang.String sessionName)

getString3



public java.lang.String 
getString3(java.lang.String sessionName,
                                   int pos,
                                   int length)

getString4



public java.lang.String 
getString4(java.lang.String sessionName,
                                   int row,
                                   int col,
                                   int length)

getStringLength



public int 
getStringLength()

inputInhibited



public int 
inputInhibited()

inputInhibited1



public int 
inputInhibited1(java.lang.String sessionName)

isCommReady



public boolean 
isCommReady()

isCommReady1



public boolean 
isCommReady1(java.lang.String sessionName)

reset



public int 
reset()

reset1



public int 
reset1(java.lang.String sessionName)

waitForStringInRect8



public int 
waitForStringInRect8(java.lang.String text,
                                int sRow,
                                int sCol,
                                int eRow,
                                int eCol,
                                long timeout,
                                boolean waitForInput,
                                boolean caseSensitive)

waitForStringInRect9



public int 
waitForStringInRect9(java.lang.String sessionName,
                                java.lang.String text,
                                int sRow,
                                int sCol,
                                int eRow,
                                int eCol,
                                long timeout,
                                boolean waitForInput,
                                boolean caseSensitive)

waitWhileStringInRect8



public int 
waitWhileStringInRect8(java.lang.String text,
                                  int sRow,
                                  int sCol,
                                  int eRow,
                                  int eCol,
                                  long timeout,
                                  boolean waitForInput,
                                  boolean caseSensitive)

waitWhileStringInRect9



public int 
waitWhileStringInRect9(java.lang.String sessionName,
                                  java.lang.String text,
                                  int sRow,
                                  int sCol,
                                  int eRow,
                                  int eCol,
                                  long timeout,
                                  boolean waitForInput,
                                  boolean caseSensitive)

isSessionActive



public boolean 
isSessionActive(java.lang.String sessionName)

startMacro1



public int 
startMacro1(java.lang.String macroName)

startMacro2



public int 
startMacro2(java.lang.String sessionName,
                       java.lang.String macroName)

getErrorMessage



public java.lang.String 
getErrorMessage()

callCustomerFunction



public java.lang.String 
callCustomerFunction(java.lang.String fncName,
                                             java.lang.String parms)


Overview	Package	Class	Tree	Serialized	Deprecated	Index	Help	API User's Guide

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD