com.wrq.apptrieve.appconn
Interface AppConnTerm

All Superinterfaces:

AppConnAidKey

All Known Implementing Classes:

AppConnRejuvenationSession, AppConnSession

public interface AppConnTerm
extends AppConnAidKey

AppConnTerm is an interface defining the Host Integrator terminal commands.

Field Summary

Fields inherited from interface com.wrq.apptrieve.appconn.AppConnAidKey

HP_ACK_Key, HP_BackSpace_Key, HP_BackTab_Key, HP_BEL_Key, HP_Break_Key, HP_BS_Key, HP_CAN_Key, HP_ClearDisplay_Key, HP_ClearLine_Key, HP_ConfigKeys_Key, HP_CR_Key, HP_CTRLA_Key, HP_CTRLB_Key, HP_CTRLBACKSLASH_Key, HP_CTRLC_Key, HP_CTRLCARET_Key, HP_CTRLD_Key, HP_CTRLE_Key, HP_CTRLF_Key, HP_CTRLG_Key, HP_CTRLH_Key, HP_CTRLI_Key, HP_CTRLJ_Key, HP_CTRLK_Key, HP_CTRLL_Key, HP_CTRLLEFTBRACKET_Key, HP_CTRLM_Key, HP_CTRLN_Key, HP_CTRLO_Key, HP_CTRLP_Key, HP_CTRLQ_Key, HP_CTRLR_Key, HP_CTRLRIGHTBRACKET_Key, HP_CTRLS_Key, HP_CTRLSPACE_Key, HP_CTRLT_Key, HP_CTRLU_Key, HP_CTRLUNDERBAR_Key, HP_CTRLV_Key, HP_CTRLW_Key, HP_CTRLX_Key, HP_CTRLY_Key, HP_CTRLZ_Key, HP_DC1_Key, HP_DC2_Key, HP_DC3_Key, HP_DC4_Key, HP_Delete_Key, HP_DeleteChar_Key, HP_DeleteCharWrap_Key, HP_DeleteLine_Key, HP_DLE_Key, HP_Down_Key, HP_EM_Key, HP_ENQ_Key, HP_Enter_Key, HP_EOT_Key, HP_Esc_Key, HP_Escape_Key, HP_ETB_Key, HP_ETX_Key, HP_Extend_Key, HP_F1_Key, HP_F2_Key, HP_F3_Key, HP_F4_Key, HP_F5_Key, HP_F6_Key, HP_F7_Key, HP_F8_Key, HP_FF_Key, HP_FS_Key, HP_GS_Key, HP_HardReset_Key, HP_HomeDown_Key, HP_HomeLeft_Key, HP_HomeRight_Key, HP_HomeUp_Key, HP_HT_Key, HP_InsertChar_Key, HP_InsertCharWrap_Key, HP_InsertLine_Key, HP_Left_Key, HP_LF_Key, HP_Menu_Key, HP_Modes_Key, HP_NAK_Key, HP_NextPage_Key, HP_NUL_Key, HP_PrevPage_Key, HP_Return_Key, HP_Right_Key, HP_RollLeft_Key, HP_RollRight_Key, HP_RS_Key, HP_ScrollDown_Key, HP_ScrollUp_Key, HP_Select_Key, HP_SI_Key, HP_SmartEnter_Key, HP_SO_Key, HP_SoftReset_Key, HP_SOH_Key, HP_Stop_Key, HP_STX_Key, HP_SUB_Key, HP_SYN_Key, HP_System_Key, HP_Tab_Key, HP_Up_Key, HP_US_Key, HP_User_Key, HP_UserCfg_Key, HP_VT_Key, IBM_AltCursor_Key, IBM_Attn_Key, IBM_AU1_Key, IBM_AU10_Key, IBM_AU11_Key, IBM_AU12_Key, IBM_AU13_Key, IBM_AU14_Key, IBM_AU15_Key, IBM_AU16_Key, IBM_AU2_Key, IBM_AU3_Key, IBM_AU4_Key, IBM_AU5_Key, IBM_AU6_Key, IBM_AU7_Key, IBM_AU8_Key, IBM_AU9_Key, IBM_BackSpace_Key, IBM_BackTab_Key, IBM_CentSymbol_Key, IBM_Clear_Key, IBM_ClearPartition_Key, IBM_CursorBlink_Key, IBM_CursorSelect_Key, IBM_Delete_Key, IBM_DeleteChar_Key, IBM_DeleteWord_Key, IBM_DestrBackSpace_Key, IBM_DeviceCancel_Key, IBM_Down_Key, IBM_DownDouble_Key, IBM_Dup_Key, IBM_Duplicate_Key, IBM_EndOfField_Key, IBM_Enter_Key, IBM_EraseEOF_Key, IBM_EraseInput_Key, IBM_ExtGR_Key, IBM_F1_Key, IBM_F10_Key, IBM_F11_Key, IBM_F12_Key, IBM_F13_Key, IBM_F14_Key, IBM_F15_Key, IBM_F16_Key, IBM_F17_Key, IBM_F18_Key, IBM_F19_Key, IBM_F2_Key, IBM_F20_Key, IBM_F21_Key, IBM_F22_Key, IBM_F23_Key, IBM_F24_Key, IBM_F3_Key, IBM_F4_Key, IBM_F5_Key, IBM_F6_Key, IBM_F7_Key, IBM_F8_Key, IBM_F9_Key, IBM_FieldDelim_Key, IBM_FieldExit_Key, IBM_FieldMark_Key, IBM_FieldMinus_Key, IBM_FieldPlus_Key, IBM_Help_Key, IBM_Hex_Key, IBM_Home_Key, IBM_Ident_Key, IBM_Insert_Key, IBM_KeyClick_Key, IBM_Left, IBM_LeftDouble_Key, IBM_NewLine_Key, IBM_NextWord_Key, IBM_NotSymbol_Key, IBM_PA1_Key, IBM_PA2_Key, IBM_PA3_Key, IBM_PageDown_Key, IBM_PageUp_Key, IBM_PanLeft_Key, IBM_PanRight_Key, IBM_PartitionJump_Key, IBM_PF1_Key, IBM_PF10_Key, IBM_PF11_Key, IBM_PF12_Key, IBM_PF13_Key, IBM_PF14_Key, IBM_PF15_Key, IBM_PF16_Key, IBM_PF17_Key, IBM_PF18_Key, IBM_PF19_Key, IBM_PF2_Key, IBM_PF20_Key, IBM_PF21_Key, IBM_PF22_Key, IBM_PF23_Key, IBM_PF24_Key, IBM_PF3_Key, IBM_PF4_Key, IBM_PF5_Key, IBM_PF6_Key, IBM_PF7_Key, IBM_PF8_Key, IBM_PF9_Key, IBM_PlusCR_Key, IBM_Print_Key, IBM_PrintPart_Key, IBM_Reset_Key, IBM_Right_Key, IBM_RightDouble_Key, IBM_RollDown_Key, IBM_RollUp_Key, IBM_Rule_Key, IBM_ScrollDown_Key, IBM_ScrollUp_Key, IBM_SLPAutoEnter_Key, IBM_SOSIGenerate_Key, IBM_SplitVBar_Key, IBM_SysRequest_Key, IBM_Tab_Key, IBM_Test_Key, IBM_Up_Key, IBM_UpDouble_Key, VT_0_Key, VT_1_Key, VT_2_Key, VT_3_Key, VT_4_Key, VT_5_Key, VT_6_Key, VT_7_Key, VT_8_Key, VT_9_Key, VT_ACK_Key, VT_BEL_Key, VT_Break_Key, VT_BS_Key, VT_BSP_Key, VT_CAN_Key, VT_Compose_Key, VT_CR_Key, VT_CTRLA_Key, VT_CTRLB_Key, VT_CTRLBACKSLASH_Key, VT_CTRLC_Key, VT_CTRLCARET_Key, VT_CTRLD_Key, VT_CTRLE_Key, VT_CTRLF_Key, VT_CTRLG_Key, VT_CTRLH_Key, VT_CTRLJ_Key, VT_CTRLK_Key, VT_CTRLL_Key, VT_CTRLM_Key, VT_CTRLN_Key, VT_CTRLO_Key, VT_CTRLP_Key, VT_CTRLQ_Key, VT_CTRLR_Key, VT_CTRLRIGHTBRACKET_Key, VT_CTRLS_Key, VT_CTRLSPACE_Key, VT_CTRLT_Key, VT_CTRLU_Key, VT_CTRLUNDERBAR_Key, VT_CTRLV_Key, VT_CTRLW_Key, VT_CTRLX_Key, VT_CTRLY_Key, VT_CTRLZ_Key, VT_CursD_Key, VT_CursL_Key, VT_CursR_Key, VT_CursU_Key, VT_DC1_Key, VT_DC2_Key, VT_DC3_Key, VT_DC4_Key, VT_Decimal_Key, VT_Del_Key, VT_Disconnect_Key, VT_DLE_Key, VT_EM_Key, VT_ENQ_Key, VT_Enter_Key, VT_EOT_Key, VT_Esc_Key, VT_ETB_Key, VT_ETX_Key, VT_F10_Key, VT_F11_Key, VT_F12_Key, VT_F13_Key, VT_F14_Key, VT_F15_Key, VT_F16_Key, VT_F17_Key, VT_F18_Key, VT_F19_Key, VT_F20_Key, VT_F6_Key, VT_F7_Key, VT_F8_Key, VT_F9_Key, VT_FF_Key, VT_Find_Key, VT_FS_Key, VT_GS_Key, VT_HoldScreen_Key, VT_HoldScreenClear_Key, VT_HoldScreenSet_Key, VT_Ins_Key, VT_KP0_Key, VT_KP1_Key, VT_KP2_Key, VT_KP3_Key, VT_KP4_Key, VT_KP5_Key, VT_KP6_Key, VT_KP7_Key, VT_KP8_Key, VT_KP9_Key, VT_KPComma_Key, VT_KPDot_Key, VT_KPMinus_Key, VT_LF_Key, VT_NAK_Key, VT_NextPage_Key, VT_NextScr_Key, VT_NUL_Key, VT_PF1_Key, VT_PF2_Key, VT_PF3_Key, VT_PF4_Key, VT_PrevPage_Key, VT_PrevScr_Key, VT_PrtD_Key, VT_Remove_Key, VT_Retrn_Key, VT_RS_Key, VT_ScrollDown_Key, VT_ScrollUp_Key, VT_Select_Key, VT_SendNull_Key, VT_SI_Key, VT_SO_Key, VT_SOH_Key, VT_Stop_Key, VT_STX_Key, VT_SUB_Key, VT_SYN_Key, VT_Tab_Key, VT_UDK10_Key, VT_UDK11_Key, VT_UDK12_Key, VT_UDK13_Key, VT_UDK14_Key, VT_UDK15_Key, VT_UDK16_Key, VT_UDK17_Key, VT_UDK18_Key, VT_UDK19_Key, VT_UDK20_Key, VT_UDK6_Key, VT_UDK7_Key, VT_UDK8_Key, VT_UDK9_Key, VT_US_Key, VT_VT_Key, VT_XAb_Key

Method Summary

java.lang.String	getStringAtCursor(int length) Gets a string of the given length from the current entity on the Host Integrator server starting at the current cursor position.
java.lang.String	getStringAtOffset(int offset, int length) Gets a string of the given length from the current entity on the Host Integrator server starting at an offset.
java.lang.String	getStringAtRowColumn(int topRow, int leftColumn, int numRows, int numColumns) Gets a string from a rectangular region of the current entity on the Host Integrator server starting at a given row and column.
TerminalField	getTerminalFieldAtCursor() Gets a TerminalField object that gives information about the terminal field at the current cursor position on the Host Integrator server.
void	insertStringAtCursor(java.lang.String string) Inserts a string into the current entity on the Host Integrator server starting at the current cursor position.
void	insertStringAtOffset(java.lang.String string, int offset) Inserts a string into the current entity on the Host Integrator server starting at an offset.
void	insertStringAtRowColumn(java.lang.String string, int rowNum, int columnNum) Inserts a string into the current entity on the Host Integrator server starting at the given row and column.
void	performAidKey(int key) Enters an aid key (for example, a Program Function key) into the current Host Integrator server session.
void	waitForCursor(int rowNum, int columnNum, int timeout) Waits for the presence of the terminal cursor at a particular terminal screen offset.
void	waitForString(java.lang.String string, int rowNum, int columnNum, int timeout) Waits for the presence of a string starting at a particular terminal screen row and column.
void	waitForStringRelCursor(java.lang.String string, int rowOffset, int columnOffset, int timeout) Waits for the presence of a string relative to the current terminal screen cursor.

Method Detail

getStringAtCursor

java.lang.String getStringAtCursor(int length)
                                   throws ApptrieveException

Gets a string of the given length from the current entity on the Host Integrator server starting at the current cursor position.

Reasons for failure include:

1. Server session has not been established.
2. Invalid length.

Parameters:

length - int - The length of the string on the entity (i.e. screen)

Returns:

java.lang.String - the display string

Throws:

ApptrieveException - - if a Host Integrator server error occurs

See Also:

getStringAtRowColumn(int, int, int, int), getStringAtOffset(int, int), insertStringAtCursor(java.lang.String), insertStringAtOffset(java.lang.String, int), insertStringAtRowColumn(java.lang.String, int, int)

getStringAtOffset

java.lang.String getStringAtOffset(int offset,
                                   int length)
                                   throws ApptrieveException

Gets a string of the given length from the current entity on the Host Integrator server starting at an offset.

Reasons for failure include:

1. Server session has not been established.
2. Invalid offset.
3. Invalid length.

Parameters:

offset - int - The offset from the start of the screen buffer

length - int - The length of the string on the entity (i.e. screen)

Returns:

java.lang.String - the display string

Throws:

ApptrieveException - - if a Host Integrator server error occurs

See Also:

getStringAtRowColumn(int, int, int, int), insertStringAtOffset(java.lang.String, int), insertStringAtRowColumn(java.lang.String, int, int)

getStringAtRowColumn

java.lang.String getStringAtRowColumn(int topRow,
                                      int leftColumn,
                                      int numRows,
                                      int numColumns)
                                      throws ApptrieveException

Gets a string from a rectangular region of the current entity on the Host Integrator server starting at a given row and column.

Reasons for failure include:

1. Server session has not been established.
2. Invalid row.
3. Invalid column.
4. Invalid number of rows.
5. Invalid number of columns.

Parameters:

topRow - int - The starting row on the entity (i.e. screen)

leftColumn - int - The starting column on the entity (i.e. screen)

numRows - int - the number of rows to get relative to the starting row

numColumns - int - the number of columns to get relative to the starting column

Returns:

java.lang.String - the display string

Throws:

ApptrieveException - - if a Host Integrator server error occurs

See Also:

getStringAtOffset(int, int), insertStringAtOffset(java.lang.String, int), insertStringAtRowColumn(java.lang.String, int, int)

getTerminalFieldAtCursor

TerminalField getTerminalFieldAtCursor()
                                       throws ApptrieveException

Gets a TerminalField object that gives information about the terminal field at the current cursor position on the Host Integrator server.

Reasons for failure include:

1. Server session has not been established.

Returns:

com.wrq.apptrieve.appconn.TerminalField - the terminal field information

Throws:

ApptrieveException - - if a Host Integrator server error occurs

See Also:

AppConnModelRecord.getTerminalAttributes(java.lang.String)

insertStringAtCursor

void insertStringAtCursor(java.lang.String string)
                          throws ApptrieveException

Inserts a string into the current entity on the Host Integrator server starting at the current cursor position.

Reasons for failure include:

1. Server session has not been established.
2. Invalid string.

Parameters:

string - java.lang.String - The string to insert

Throws:

ApptrieveException - - if a Host Integrator server error occurs

See Also:

getStringAtOffset(int, int), getStringAtRowColumn(int, int, int, int), insertStringAtOffset(java.lang.String, int), insertStringAtRowColumn(java.lang.String, int, int)

insertStringAtOffset

void insertStringAtOffset(java.lang.String string,
                          int offset)
                          throws ApptrieveException

Inserts a string into the current entity on the Host Integrator server starting at an offset.

Reasons for failure include:

1. Server session has not been established.
2. Invalid string.
3. Invalid offset.

Parameters:

string - java.lang.String - The string

offset - int - The offset from the start of the screen buffer

Throws:

ApptrieveException - - if a Host Integrator server error occurs

See Also:

getStringAtOffset(int, int), getStringAtRowColumn(int, int, int, int), insertStringAtRowColumn(java.lang.String, int, int)

insertStringAtRowColumn

void insertStringAtRowColumn(java.lang.String string,
                             int rowNum,
                             int columnNum)
                             throws ApptrieveException

Inserts a string into the current entity on the Host Integrator server starting at the given row and column.

Reasons for failure include:

1. Server session has not been established.
2. Invalid string.
3. Invalid row.
4. Invalid column.

Parameters:

string - java.lang.String - The string to insert

rowNum - int - The row number of the starting location for insertion on the entity (i.e. screen)

columnNum - int - The column number of the starting location for insertion on the entity (i.e. screen)

Throws:

ApptrieveException - - if a Host Integrator server error occurs

See Also:

getStringAtOffset(int, int), getStringAtRowColumn(int, int, int, int), insertStringAtOffset(java.lang.String, int)

performAidKey

void performAidKey(int key)
                   throws ApptrieveException

Enters an aid key (for example, a Program Function key) into the current Host Integrator server session.

The key is one of the terminal key constants defined in the com.wrq.apptrieve.appconn.AppConnTerm class.

Parameters:

key - int - The aid key AppConnTerm constant

Throws:

ApptrieveException - - if a Host Integrator server error occurs

See Also:

waitForCursor(int, int, int), AppConnModel.waitForEntityChange(java.lang.String, int), waitForString(java.lang.String, int, int, int), waitForStringRelCursor(java.lang.String, int, int, int)

waitForCursor

void waitForCursor(int rowNum,
                   int columnNum,
                   int timeout)
                   throws ApptrieveException

Waits for the presence of the terminal cursor at a particular terminal screen offset.

Exception occurs if timeout period elapses before the cursor is at the offset.

Parameters:

rowNum - int - the screen row number for the cursor

columnNum - int - the screen column number for the cursor

timeout - int - the timeout period in seconds

Throws:

ApptrieveException - - if a Host Integrator server error occurs

See Also:

performAidKey(int), AppConnModel.waitForEntityChange(java.lang.String, int), waitForString(java.lang.String, int, int, int), waitForStringRelCursor(java.lang.String, int, int, int)

waitForString

void waitForString(java.lang.String string,
                   int rowNum,
                   int columnNum,
                   int timeout)
                   throws ApptrieveException

Waits for the presence of a string starting at a particular terminal screen row and column.

Exception occurs if timeout period elapses before the string appears at the row and column.

Parameters:

string - java.lang.String - the string to wait for

rowNum - int - the screen row starting number for the string (-1 matches any row)

columnNum - int - the screen column starting number for the string (-1 matches any column)

timeout - int - the timeout period in seconds

Throws:

ApptrieveException - - if a Host Integrator server error occurs

See Also:

performAidKey(int), waitForCursor(int, int, int), AppConnModel.waitForEntityChange(java.lang.String, int), waitForStringRelCursor(java.lang.String, int, int, int)

waitForStringRelCursor

void waitForStringRelCursor(java.lang.String string,
                            int rowOffset,
                            int columnOffset,
                            int timeout)
                            throws ApptrieveException

Waits for the presence of a string relative to the current terminal screen cursor.

Exception occurs if timeout period elapses before the string appears at the offset.

Parameters:

string - java.lang.String - the string to wait for

rowOffset - int - the starting screen location for the string relative to current cursor row

columnOffset - int - the starting screen column location for the string relative to current cursor column

timeout - int - the timeout period in seconds

Throws:

ApptrieveException - - if a Host Integrator server error occurs

See Also:

performAidKey(int), waitForCursor(int, int, int), AppConnModel.waitForEntityChange(java.lang.String, int), waitForString(java.lang.String, int, int, int)