|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ISessionService
Class Name: ISessionService Provides the service interface for the session services. This service is scoped at the
telnet session / view level.
Class Type: Interface
Base Class: IService
Intf Class: None
Description:
| Field Summary | |
|---|---|
static String |
CLASSNAME
The fully-qualified name of this class. |
static String |
COPYRIGHT
The HATSCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file. |
| Method Summary | |
|---|---|
void |
addPresentationListener(com.ibm.hats.runtime.events.IPresentationListener listener)
Adds a presentation listener. |
void |
addSessionServiceListener(com.ibm.hats.runtime.events.ISessionServiceListener listener)
Adds a session service listener. |
boolean |
canSendCommand(String command)
Checks the command to evaluate whether or not it can be sent. |
void |
disconnect()
Performs a disconnect of this session. |
void |
disconnect(Properties parameters)
Performs a disconnect of this session. |
com.ibm.hats.common.Application |
getApplication()
Retrieve the application. |
String |
getApplicationId()
Returns the application ID. |
IApplicationService |
getApplicationService()
Retrieve the application service. |
Hashtable |
getBiDiStore()
Returns the Bidi parameters store hash table unic for each session service. |
String |
getClientId()
Returns the client ID. |
com.ibm.hats.util.StateType |
getCurrentState()
This is a command to retrieve the current state. |
HostScreen |
getHostScreen()
Returns the last host screen that was processed by the runtime. |
com.ibm.hats.core.sdo.IHostScreenDataAccessService |
getHostScreenDataAccessService()
Retrieve the interface for accessing the model. |
Locale |
getLocale()
Returns the preferred locale of this session service instance. |
com.ibm.hats.core.sdo.IMacroPromptDataAccessService |
getMacroPromptDataAccessService()
Retrieve the interface for accessing the model. |
com.ibm.hats.core.sdo.IParameterDataAccessService |
getParameterDataAccessService()
Retrieve the interface for accessing the model. |
IRuntimeService |
getRuntimeService()
Returns the current runtime service. |
com.ibm.hats.util.State |
getSessionServiceState()
Retrieve the session state. |
String |
getViewId()
Returns the view ID. |
boolean |
isAsyncUpdateEnabled()
Returns whether asynchronous update support is enabled and in use by this session service instance. |
boolean |
isCommandSupported(String command)
Checks the command to evaluate whether or not it is supported. |
void |
playMacro(String macroName)
Command to play a macro. |
void |
playMacro(String macroName,
Properties prompts)
Play a macro. |
void |
removePresentationListener(com.ibm.hats.runtime.events.IPresentationListener listener)
Removes a presentation listener. |
void |
removeSessionServiceListener(com.ibm.hats.runtime.events.ISessionServiceListener listener)
Removes a session service listener. |
void |
sendCommand(String command)
Command to send a command. |
void |
sendCommand(String command,
Properties parameters)
Command to send a command. |
void |
sendContinue()
Send the Continue command. |
void |
sendEnter()
Command to send the [enter] key. |
void |
sendF1()
Command to send the [pf1] key. |
void |
sendF10()
Command to send the [pf10] key. |
void |
sendF11()
Command to send the [pf11] key. |
void |
sendF12()
Command to send the [pf12] key. |
void |
sendF13()
Command to send the [pf13] key. |
void |
sendF14()
Command to send the [pf14] key. |
void |
sendF15()
Command to send the [pf15] key. |
void |
sendF16()
Command to send the [pf16] key. |
void |
sendF17()
Command to send the [pf17] key. |
void |
sendF18()
Command to send the [pf18] key. |
void |
sendF19()
Command to send the [pf19] key. |
void |
sendF2()
Command to send the [pf2] key. |
void |
sendF20()
Command to send the [pf20] key. |
void |
sendF21()
Command to send the [pf21] key. |
void |
sendF22()
Command to send the [pf22] key. |
void |
sendF23()
Command to send the [pf23] key. |
void |
sendF24()
Command to send the [pf24] key. |
void |
sendF3()
Command to send the [pf3] key. |
void |
sendF4()
Command to send the [pf4] key. |
void |
sendF5()
Command to send the [pf5] key. |
void |
sendF6()
Command to send the [pf6] key. |
void |
sendF7()
Command to send the [pf7] key. |
void |
sendF8()
Command to send the [pf8] key. |
void |
sendF9()
Command to send the [pf9] key. |
void |
sendRefresh()
Command to send a refresh. |
void |
sendShowDefault()
Command to send a show default. |
void |
start(Properties parameters)
Command to start. |
void |
stop()
Command to stop. |
void |
updatePresentation(com.ibm.hats.runtime.presentation.IPresentable presentable)
Update the presentation. |
| Methods inherited from interface com.ibm.hats.runtime.services.IService |
|---|
getServiceManager |
| Field Detail |
|---|
static final String COPYRIGHT
static final String CLASSNAME
| Method Detail |
|---|
void addPresentationListener(com.ibm.hats.runtime.events.IPresentationListener listener)
listener - The presentation listener to be added.void addSessionServiceListener(com.ibm.hats.runtime.events.ISessionServiceListener listener)
listener - The session service listener to be added.boolean canSendCommand(String command)
command - The command to be evaluated.
void disconnect()
void disconnect(Properties parameters)
parameters - null or the set of parameters to pass with the disconnect commandcom.ibm.hats.common.Application getApplication()
String getApplicationId()
IApplicationService getApplicationService()
String getClientId()
com.ibm.hats.core.sdo.IHostScreenDataAccessService getHostScreenDataAccessService()
com.ibm.hats.core.sdo.IMacroPromptDataAccessService getMacroPromptDataAccessService()
com.ibm.hats.core.sdo.IParameterDataAccessService getParameterDataAccessService()
com.ibm.hats.util.StateType getCurrentState()
HostScreen getHostScreen()
IRuntimeService getRuntimeService()
com.ibm.hats.util.State getSessionServiceState()
String getViewId()
boolean isCommandSupported(String command)
command - The command to be evaluated.
void playMacro(String macroName)
macroName - The name of the macro to play.
void playMacro(String macroName,
Properties prompts)
macroName - The name of the macro to play.prompts - The prompt properties.void removePresentationListener(com.ibm.hats.runtime.events.IPresentationListener listener)
listener - The presentation listener to be removed.void removeSessionServiceListener(com.ibm.hats.runtime.events.ISessionServiceListener listener)
listener - The session service listener to be removed.void sendContinue()
void sendEnter()
void sendF1()
void sendF2()
void sendF3()
void sendF4()
void sendF5()
void sendF6()
void sendF7()
void sendF8()
void sendF9()
void sendF10()
void sendF11()
void sendF12()
void sendF13()
void sendF14()
void sendF15()
void sendF16()
void sendF17()
void sendF18()
void sendF19()
void sendF20()
void sendF21()
void sendF22()
void sendF23()
void sendF24()
void sendCommand(String command)
command - The command.
void sendCommand(String command,
Properties parameters)
command - The command.parameters - Parameter overridesvoid sendRefresh()
void sendShowDefault()
void start(Properties parameters)
parameters - Usually connection or global variable overrides.void stop()
void updatePresentation(com.ibm.hats.runtime.presentation.IPresentable presentable)
presentable - The presentable.Hashtable getBiDiStore()
ISessionService.getBiDiStore()Locale getLocale()
boolean isAsyncUpdateEnabled()
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||