HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.runtime.services
Interface ISessionService

All Superinterfaces:
IService

public interface ISessionService
extends IService

Class Name: ISessionService
Class Type:
Interface
Base Class:
IService
Intf Class:
None
Description:
Provides the service interface for the session services. This service is scoped at the telnet session / view level.


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

COPYRIGHT

static final String COPYRIGHT
The HATSCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.

See Also:
Constant Field Values

CLASSNAME

static final String CLASSNAME
The fully-qualified name of this class. This is used for controlling and displaying traces.

Method Detail

addPresentationListener

void addPresentationListener(com.ibm.hats.runtime.events.IPresentationListener listener)
Adds a presentation listener.

Parameters:
listener - The presentation listener to be added.

addSessionServiceListener

void addSessionServiceListener(com.ibm.hats.runtime.events.ISessionServiceListener listener)
Adds a session service listener.

Parameters:
listener - The session service listener to be added.

canSendCommand

boolean canSendCommand(String command)
Checks the command to evaluate whether or not it can be sent.

Parameters:
command - The command to be evaluated.
Returns:
Returns true if the command can be sent, false otherwise.

disconnect

void disconnect()
Performs a disconnect of this session.


disconnect

void disconnect(Properties parameters)
Performs a disconnect of this session.

Parameters:
parameters - null or the set of parameters to pass with the disconnect command
Since:
7.0.01

getApplication

com.ibm.hats.common.Application getApplication()
Retrieve the application.

Returns:
Returns the application.

getApplicationId

String getApplicationId()
Returns the application ID.

Returns:
The application ID.

getApplicationService

IApplicationService getApplicationService()
Retrieve the application service.

Returns:
Returns the application service.

getClientId

String getClientId()
Returns the client ID.

Returns:
The client ID.

getHostScreenDataAccessService

com.ibm.hats.core.sdo.IHostScreenDataAccessService getHostScreenDataAccessService()
Retrieve the interface for accessing the model.

Returns:
Returns the interface for accessing the model.

getMacroPromptDataAccessService

com.ibm.hats.core.sdo.IMacroPromptDataAccessService getMacroPromptDataAccessService()
Retrieve the interface for accessing the model.

Returns:
Returns the interface for accessing the model of Macro Prompts

getParameterDataAccessService

com.ibm.hats.core.sdo.IParameterDataAccessService getParameterDataAccessService()
Retrieve the interface for accessing the model.

Returns:
Returns the interface for accessing the model of Parameters

getCurrentState

com.ibm.hats.util.StateType getCurrentState()
This is a command to retrieve the current state.

Returns:
The current state for this SessionService.

getHostScreen

HostScreen getHostScreen()
Returns the last host screen that was processed by the runtime. This method does not necessarily return the current host screen of the host session.

Returns:
The host screen.

getRuntimeService

IRuntimeService getRuntimeService()
Returns the current runtime service.

Returns:
The runtime service.

getSessionServiceState

com.ibm.hats.util.State getSessionServiceState()
Retrieve the session state.

Returns:
The session state.

getViewId

String getViewId()
Returns the view ID.

Returns:
The view ID.

isCommandSupported

boolean isCommandSupported(String command)
Checks the command to evaluate whether or not it is supported.

Parameters:
command - The command to be evaluated.
Returns:
Returns true if the command is supported, false otherwise.

playMacro

void playMacro(String macroName)
Command to play a macro.

Parameters:
macroName - The name of the macro to play.

playMacro

void playMacro(String macroName,
               Properties prompts)
Play a macro.

Parameters:
macroName - The name of the macro to play.
prompts - The prompt properties.

removePresentationListener

void removePresentationListener(com.ibm.hats.runtime.events.IPresentationListener listener)
Removes a presentation listener.

Parameters:
listener - The presentation listener to be removed.

removeSessionServiceListener

void removeSessionServiceListener(com.ibm.hats.runtime.events.ISessionServiceListener listener)
Removes a session service listener.

Parameters:
listener - The session service listener to be removed.

sendContinue

void sendContinue()
Send the Continue command.


sendEnter

void sendEnter()
Command to send the [enter] key.


sendF1

void sendF1()
Command to send the [pf1] key.


sendF2

void sendF2()
Command to send the [pf2] key.


sendF3

void sendF3()
Command to send the [pf3] key.


sendF4

void sendF4()
Command to send the [pf4] key.


sendF5

void sendF5()
Command to send the [pf5] key.


sendF6

void sendF6()
Command to send the [pf6] key.


sendF7

void sendF7()
Command to send the [pf7] key.


sendF8

void sendF8()
Command to send the [pf8] key.


sendF9

void sendF9()
Command to send the [pf9] key.


sendF10

void sendF10()
Command to send the [pf10] key.


sendF11

void sendF11()
Command to send the [pf11] key.


sendF12

void sendF12()
Command to send the [pf12] key.


sendF13

void sendF13()
Command to send the [pf13] key.


sendF14

void sendF14()
Command to send the [pf14] key.


sendF15

void sendF15()
Command to send the [pf15] key.


sendF16

void sendF16()
Command to send the [pf16] key.


sendF17

void sendF17()
Command to send the [pf17] key.


sendF18

void sendF18()
Command to send the [pf18] key.


sendF19

void sendF19()
Command to send the [pf19] key.


sendF20

void sendF20()
Command to send the [pf20] key.


sendF21

void sendF21()
Command to send the [pf21] key.


sendF22

void sendF22()
Command to send the [pf22] key.


sendF23

void sendF23()
Command to send the [pf23] key.


sendF24

void sendF24()
Command to send the [pf24] key.


sendCommand

void sendCommand(String command)
Command to send a command.

Parameters:
command - The command.

sendCommand

void sendCommand(String command,
                 Properties parameters)
Command to send a command.

Parameters:
command - The command.
parameters - Parameter overrides

sendRefresh

void sendRefresh()
Command to send a refresh.


sendShowDefault

void sendShowDefault()
Command to send a show default.


start

void start(Properties parameters)
Command to start.

Parameters:
parameters - Usually connection or global variable overrides.

stop

void stop()
Command to stop.


updatePresentation

void updatePresentation(com.ibm.hats.runtime.presentation.IPresentable presentable)
Update the presentation.

Parameters:
presentable - The presentable.

getBiDiStore

Hashtable getBiDiStore()
Returns the Bidi parameters store hash table unic for each session service.

Returns:
The hash table containing BiDi parameters.
See Also:
ISessionService.getBiDiStore()

getLocale

Locale getLocale()
Returns the preferred locale of this session service instance.

Returns:
client locale.

isAsyncUpdateEnabled

boolean isAsyncUpdateEnabled()
Returns whether asynchronous update support is enabled and in use by this session service instance.

Returns:
true if asynchronous updating is enabled

HATS 7.5.1 (201005110649)