Services Builder for Screens

com.attachmate.sc.ssa
Interface INavSystem


public interface INavSystem

This interface provides access to system level functions of the navigation engine from a custom step and scripted portions.


Method Summary
 java.lang.String getAction()
          Pinpoint Customization Only
Called by the navigation engine to query for the transition action a scripted implementation set for a given task step
 boolean getRecognized()
          Pinpoint Customization Only
Called by the navigation engine to query if a script implmentation recognized a given screen
 void logErrorEvent(java.lang.String msg)
          Logs a user event of type Error to MCS
 void logInfoEvent(java.lang.String msg)
          Logs a user event of type Info to MCS
 void logWarningEvent(java.lang.String msg)
          Logs a user event of type Warning to MCS
 void setAction(java.lang.String action)
          Pinpoint Customization Only
Called by script implementation to set the transition action to be used by the navigation engine to proceed away from a given task step
 void setRecognized(boolean recognized)
          Pinpoint Customization Only
Called by script implementations to let the navigation engine know if a given screeen is recognized
 

Method Detail

logErrorEvent

public void logErrorEvent(java.lang.String msg)
Logs a user event of type Error to MCS

Parameters:
msg - The message of the event to be logged

logWarningEvent

public void logWarningEvent(java.lang.String msg)
Logs a user event of type Warning to MCS

Parameters:
msg - The message of the event to be logged

logInfoEvent

public void logInfoEvent(java.lang.String msg)
Logs a user event of type Info to MCS

Parameters:
msg - The message of the event to be logged

setRecognized

public void setRecognized(boolean recognized)
Pinpoint Customization Only
Called by script implementations to let the navigation engine know if a given screeen is recognized

Parameters:
recognized - - True if the screen is recognized, false otherwise

getRecognized

public boolean getRecognized()
Pinpoint Customization Only
Called by the navigation engine to query if a script implmentation recognized a given screen

Returns:
True if the script recognized the screen, false otherwise

setAction

public void setAction(java.lang.String action)
Pinpoint Customization Only
Called by script implementation to set the transition action to be used by the navigation engine to proceed away from a given task step

Parameters:
action - The transition action to be used by the navigation engine to navigate away from a given task step. The action parameter can either be in the brace mnemonic form or in the HLLAPI @ mnemonic form.
The following is a table of the supported actions for IBM hosts:
KeyBrace MnemonicHLLAPI Mnemonic
CMD_F1{F1}@1
CMD_F2{F2}@2
CMD_F3{F3}@3
CMD_F4{F4}@4
CMD_F5{F5}@5
CMD_F6{F6}@6
CMD_F7{F7}@7
CMD_F8{F8}@8
CMD_F9{F9}@9
CMD_F10{F10}@a
CMD_F11{F11}@b
CMD_F12{F12}@c
CMD_F13{F13}@d
CMD_F14{F14}@e
CMD_F15{F15}@f
CMD_F16{F16}@g
CMD_F17{F17}@h
CMD_F18{F18}@i
CMD_F19{F19}@j
CMD_F20{F20}@k
CMD_F21{F21}@l
CMD_F22{F22}@m
CMD_F23{F23}@n
CMD_F24{F24}@o
CMD_ROLLDOWN{PageUp}@u
CMD_ROLLUP{PageDown}@v
CMD_PA1{PA1}@x
CMD_PA2{PA2}@y
CMD_PA3{PA3}@z
CMD_TRANSMIT{Enter}@E
CMD_CLEAR{Clear}@C
CMD_PRINT{Print}@P
CMD_RESET{Reset}@R
CMD_ATTENTION{Attention}@A@Q
CMD_TEST{Test Req}@A@C
CMD_HELP{Help}NA
CMD_SYSTEM_REQUEST{System Request}NA

The following is a table of supported actions for UTS hosts:
KeyBrace MnemonicHLLAPI Mnemonic
CMD_F1{F1}@1
CMD_F2{F2}@2
CMD_F3{F3}@3
CMD_F4{F4}@4
CMD_F5{F5}@5
CMD_F6{F6}@6
CMD_F7{F7}@7
CMD_F8{F8}@8
CMD_F9{F9}@9
CMD_F10{F10}@a
CMD_F11{F11}@b
CMD_F12{F12}@c
CMD_F13{F13}@d
CMD_F14{F14}@e
CMD_F15{F15}@f
CMD_F16{F16}@g
CMD_F17{F17}@h
CMD_F18{F18}@i
CMD_F19{F19}@j
CMD_F20{F20}@k
CMD_F21{F21}@l
CMD_F22{F22}@m
CMD_TRANSMIT{Enter}@E
CMD_MESSAGE_WAIT{Message Wait}@A@M
CMD_SET_SOE{Set SOE}@A@S

The following is a table of supported actions for T27 hosts:
KeyBrace MnemonicHLLAPI Mnemonic
CMD_TRANSMIT{Enter}@E
CMD_TRANSMIT_LINE{Transmit Line}@A@x
CMD_ENABLE_FORMS{Enable Forms}@A@f
CMD_DISABLE_FORMS{Disable Forms}@A@q
CMD_SPECIFY{Specify}@A@H
CMD_RECEIVE{Receive}@A@M
CMD_LOCAL{Local}@A@W
CMD_CTRL{Control}@A@^

The following is a table of supported actions for VT hosts:
KeyBrace MnemonicHLLAPI Mnemonic
CMD_TRANSMIT{Enter}@E
CMD_F1{F1}@1
CMD_F2{F2}@2
CMD_F3{F3}@3
CMD_F4{F4}@4
CMD_F5{F5}@5
CMD_F6{F6}@6
CMD_F7{F7}@7
CMD_F8{F8}@8
CMD_F9{F9}@9
CMD_F10{F10}@a
CMD_F11{F11}@b
CMD_F12{F12}@c
CMD_F13{F13}@d
CMD_F14{F14}@e
CMD_F15{F15}@f
CMD_F16{F16}@g
CMD_F17{F17}@h
CMD_F18{F18}@i
CMD_F19{F19}@j
CMD_F20{F20}@k
CMD_PREVIOUS{Previous}@u
CMD_NEXT{Next}@v
CMD_FIND{Find}@A@f
CMD_INSERT{Insert}@A@I
CMD_REMOVE{Remove}@D
CMD_SELECT{Select}@A@s
CMD_UP{Up}@U
CMD_DOWN{Down}@V
CMD_LEFT{Left}@L
CMD_RIGHT{Right}@Z
CMD_PF1{PF1}@w
CMD_PF2{PF2}@x
CMD_PF3{PF3}@y
CMD_PF4{PF4}@z
CMD_TAB{Tab}@T
CMD_BACKSPACE{Backspace}@<
CMD_HOLD{Hold}@H
CMD_PRINT{Print}@P
CMD_BREAK{Break}@A@Q
CMD_COMPOSE{Compose}@X
CMD_KEYPAD_0{Keypad 0}@A@0
CMD_KEYPAD_1{Keypad 1}@A@1
CMD_KEYPAD_2{Keypad 2}@A@2
CMD_KEYPAD_3{Keypad 3}@A@3
CMD_KEYPAD_4{Keypad 4}@A@4
CMD_KEYPAD_5{Keypad 5}@A@5
CMD_KEYPAD_6{Keypad 6}@A@6
CMD_KEYPAD_7{Keypad 7}@A@7
CMD_KEYPAD_8{Keypad 8}@A@8
CMD_KEYPAD_9{Keypad 9}@A@9
CMD_KEYPAD_MINUS{Keypad -}@A@-
CMD_KEYPAD_COMMA{Keypad ,}@A@,
CMD_KEYPAD_ENTER{Keypad Enter}@A@E
CMD_KEYPAD_DECIMAL{Keypad .}@A@.
CMD_KEYPAD_MULTIPLY{Keypad *}@A@*
CMD_KEYPAD_DIVIDE{Keypad /}@A@/
CMD_KEYPAD_PLUS{Keypad +}@A@+
CMD_RETURN{Return}@N
CMD_ESCAPE{Escape}@A@R
CMD_SHIFT_F1{Shift F1}@S@1
CMD_SHIFT_F2{Shift F2}@S@2
CMD_SHIFT_F3{Shift F3}@S@3
CMD_SHIFT_F4{Shift F4}@S@4
CMD_SHIFT_F5{Shift F5}@S@5
CMD_SHIFT_F6{Shift F6}@S@6
CMD_SHIFT_F7{Shift F7}@S@7
CMD_SHIFT_F8{Shift F8}@S@8
CMD_SHIFT_F9{Shift F9}@S@9
CMD_SHIFT_F10{Shift F10}@S@a
CMD_SHIFT_F11{Shift F11}@S@b
CMD_SHIFT_F12{Shift F12}@S@c
CMD_SHIFT_F13{Shift F13}@S@d
CMD_SHIFT_F14{Shift F14}@S@e
CMD_SHIFT_F15{Shift F15}@S@f
CMD_SHIFT_F16{Shift F16}@S@g
CMD_SHIFT_F17{Shift F17}@S@h
CMD_SHIFT_F18{Shift F18}@S@i
CMD_SHIFT_F19{Shift F19}@S@j
CMD_SHIFT_F20{Shift F20}@S@k
CMD_CONTROL_AT{Control @}@^@0
CMD_CONTROL_A{Control A}@^@A
CMD_CONTROL_B{Control B}@^@B
CMD_CONTROL_C{Control C}@^@C
CMD_CONTROL_D{Control D}@^@D
CMD_CONTROL_E{Control E}@^@E
CMD_CONTROL_F{Control F}@^@F
CMD_CONTROL_G{Control G}@^@G
CMD_CONTROL_H{Control H}@^@H
CMD_CONTROL_I{Control I}@^@I
CMD_CONTROL_J{Control J}@^@J
CMD_CONTROL_K{Control K}@^@K
CMD_CONTROL_L{Control L}@^@L
CMD_CONTROL_M{Control M}@^@M
CMD_CONTROL_N{Control N}@^@N
CMD_CONTROL_O{Control O}@^@O
CMD_CONTROL_P{Control P}@^@P
CMD_CONTROL_Q{Control Q}@^@Q
CMD_CONTROL_R{Control R}@^@R
CMD_CONTROL_S{Control S}@^@S
CMD_CONTROL_T{Control T}@^@T
CMD_CONTROL_U{Control U}@^@U
CMD_CONTROL_V{Control V}@^@V
CMD_CONTROL_W{Control W}@^@W
CMD_CONTROL_X{Control X}@^@X
CMD_CONTROL_Y{Control Y}@^@Y
CMD_CONTROL_Z{Control Z}@^@Z
CMD_CONTROL_LBRACKET{Control [}@^@[
CMD_CONTROL_RBRACKET{Control ]}@^@]
CMD_CONTROL_BACKSLASH{Control \\}@^@\\
CMD_CONTROL_CARET{Control ^}@^@^
CMD_CONTROL_UNDERSCORE{Control _}@^@_
CMD_NONE{Input}@0


getAction

public java.lang.String getAction()
Pinpoint Customization Only
Called by the navigation engine to query for the transition action a scripted implementation set for a given task step

Returns:
The transition action a scripted implementation set for a given task step

Services Builder for Screens