com.ibm.connector2.hod
Class J2HODInteractionSpec

java.lang.Object
  |
  +--com.ibm.connector2.hod.J2HODInteractionSpec
All Implemented Interfaces:
javax.resource.cci.InteractionSpec, java.io.Serializable

public class J2HODInteractionSpec
extends java.lang.Object
implements javax.resource.cci.InteractionSpec

This class defines an interaction specification which holds all interaction-relevant properties.

Properties

The following table lists the properties:

Property Name Type

Default

Access
cursorColumn Integer 0 get/set
cursorRow Integer 0 get/set
cursorRecognizeColumn Integer 0 get/set
cursorRecognizeRow Integer 0 get/set
executionTimeout Integer 60000 get/set
interactionVerb Integer InteractionSpecModeProperties.MODE_SEND_RECEIVE get/set
keyName String HODInteractionSpec.ENTER get/set
recognizeColumn Integer 0 get/set
recognizeRow Integer 0 get/set
recognizeString String "" get/set
screenDescriptors Vector get/set
screenName String get/set
waitTime Integer 0 get/set

See Also:
Serialized Form

Field Summary
static java.lang.String CLEAR
           
static java.lang.String ENTER
           
static int EXECUTION_TIMEOUT_DEFAULT
           
static java.lang.String PA1
           
static java.lang.String PA2
           
static java.lang.String PA3
           
static java.lang.String PAGEDWN
           
static java.lang.String PAGEUP
           
static java.lang.String PF1
           
static java.lang.String PF10
           
static java.lang.String PF11
           
static java.lang.String PF12
           
static java.lang.String PF13
           
static java.lang.String PF14
           
static java.lang.String PF15
           
static java.lang.String PF16
           
static java.lang.String PF17
           
static java.lang.String PF18
           
static java.lang.String PF19
           
static java.lang.String PF2
           
static java.lang.String PF20
           
static java.lang.String PF21
           
static java.lang.String PF22
           
static java.lang.String PF23
           
static java.lang.String PF24
           
static java.lang.String PF3
           
static java.lang.String PF4
           
static java.lang.String PF5
           
static java.lang.String PF6
           
static java.lang.String PF7
           
static java.lang.String PF8
           
static java.lang.String PF9
           
static java.lang.String RESET
           
 
Fields inherited from interface javax.resource.cci.InteractionSpec
SYNC_RECEIVE, SYNC_SEND, SYNC_SEND_RECEIVE
 
Constructor Summary
J2HODInteractionSpec()
          Creates J2HODInteractionSpec instance.
 
Method Summary
 java.lang.Integer getCursorColumn()
          Gets the cursorColumn property (java.lang.Integer) value.
 java.lang.Integer getCursorRecognizeColumn()
          Gets the cursorRecognizeColumn property (java.lang.Integer) value.
 java.lang.Integer getCursorRecognizeRow()
          Gets the cursorRecognizeRow property (java.lang.Integer) value.
 java.lang.Integer getCursorRow()
          Gets the cursorRow property (java.lang.Integer) value.
 java.lang.Integer getExecutionTimeout()
          Gets the executionTimeout property (java.lang.Integer) value.
 java.lang.Integer getInteractionVerb()
          Gets the interactionVerb property (java.lang.Integer) value.
 java.lang.String getKeyName()
          Gets the keyName property (java.lang.String) value.
 java.lang.Integer getRecognizeColumn()
          Gets the recognizeColumn property (java.lang.Integer) value.
 java.lang.Integer getRecognizeRow()
          Gets the recognizeRow property (java.lang.Integer) value.
 java.lang.String getRecognizeString()
          Gets the recognizeString property (java.lang.String) value.
 java.util.Vector getScreenDescriptors()
          Gets the screenDescriptors property (java.util.Vector) value.
 java.lang.String getScreenName()
          Gets the screenName property (java.lang.String) value.
 java.lang.Integer getWaitTime()
          Gets the waitTime property (java.lang.Integer) value.
 void setCursorColumn(java.lang.Integer cursorColumn)
          Sets the cursorColumn property (java.lang.Integer) value for the column coordinate of cursor position.
 void setCursorRecognizeColumn(java.lang.Integer cursorRecognizeColumn)
          Sets the cursorRecognizeColumn property (java.lang.Integer) value for the column coordinate of a string to be recognized.
 void setCursorRecognizeRow(java.lang.Integer cursorRecognizeRow)
          Sets the cursorRecognizeRow property (java.lang.Integer) value for the row coordinate of a string to be recognized.
 void setCursorRow(java.lang.Integer cursorRow)
          Sets the cursorRow property (java.lang.Integer) value for the row coordinate of cursor position.
 void setExecutionTimeout(java.lang.Integer executionTimeout)
          Sets the executionTimeout property (java.lang.Integer) value for entire interaction process.
 void setInteractionVerb(java.lang.Integer interactionVerb)
          Sets the interactionVerb property (java.lang.Integer) value to allow send and/or receive data.
 void setKeyName(java.lang.String keyName)
          Sets the keyName property (java.lang.String) value.
 void setRecognizeColumn(java.lang.Integer recognizeColumn)
          Sets the recognizeColumn property (java.lang.Integer) value.
 void setRecognizeRow(java.lang.Integer recognizeRow)
          Sets the recognizeRow property (java.lang.Integer) value.
 void setRecognizeString(java.lang.String recognizeString)
          Sets the recognizeString property (java.lang.String) value.
 void setScreenDescriptors(java.util.Vector screenDescriptors)
          Sets the screenDescriptors property (java.util.Vector) value.
 void setScreenName(java.lang.String screenName)
          Sets the screenName property (java.lang.String) value.
 void setWaitTime(java.lang.Integer waitTime)
          Sets the waitTime property (java.lang.Integer) value to allow additional delay for host updates.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EXECUTION_TIMEOUT_DEFAULT

public static final int EXECUTION_TIMEOUT_DEFAULT

ENTER

public static final java.lang.String ENTER

CLEAR

public static final java.lang.String CLEAR

PF1

public static final java.lang.String PF1

PF2

public static final java.lang.String PF2

PF3

public static final java.lang.String PF3

PF4

public static final java.lang.String PF4

PF5

public static final java.lang.String PF5

PF6

public static final java.lang.String PF6

PF7

public static final java.lang.String PF7

PF8

public static final java.lang.String PF8

PF9

public static final java.lang.String PF9

PF10

public static final java.lang.String PF10

PF11

public static final java.lang.String PF11

PF12

public static final java.lang.String PF12

PF13

public static final java.lang.String PF13

PF14

public static final java.lang.String PF14

PF15

public static final java.lang.String PF15

PF16

public static final java.lang.String PF16

PF17

public static final java.lang.String PF17

PF18

public static final java.lang.String PF18

PF19

public static final java.lang.String PF19

PF20

public static final java.lang.String PF20

PF21

public static final java.lang.String PF21

PF22

public static final java.lang.String PF22

PF23

public static final java.lang.String PF23

PF24

public static final java.lang.String PF24

PA1

public static final java.lang.String PA1

PA2

public static final java.lang.String PA2

PA3

public static final java.lang.String PA3

PAGEUP

public static final java.lang.String PAGEUP

PAGEDWN

public static final java.lang.String PAGEDWN

RESET

public static final java.lang.String RESET
Constructor Detail

J2HODInteractionSpec

public J2HODInteractionSpec()
Creates J2HODInteractionSpec instance.
Method Detail

getCursorColumn

public java.lang.Integer getCursorColumn()
Gets the cursorColumn property (java.lang.Integer) value.
Returns:
java.lang.Integer - The cursorColumn property value.
See Also:
setCursorColumn(java.lang.Integer)

getCursorRecognizeColumn

public java.lang.Integer getCursorRecognizeColumn()
Gets the cursorRecognizeColumn property (java.lang.Integer) value.
Returns:
java.lang.Integer - The cursorRecognizeColumn property value.
See Also:
setCursorRecognizeColumn(java.lang.Integer)

getCursorRecognizeRow

public java.lang.Integer getCursorRecognizeRow()
Gets the cursorRecognizeRow property (java.lang.Integer) value.
Returns:
java.lang.Integer - The cursorRecognizeRow property value.
See Also:
setCursorRecognizeRow(java.lang.Integer)

getCursorRow

public java.lang.Integer getCursorRow()
Gets the cursorRow property (java.lang.Integer) value.
Returns:
java.lang.Integer - The cursorRow property value.
See Also:
setCursorRow(java.lang.Integer)

getExecutionTimeout

public java.lang.Integer getExecutionTimeout()
Gets the executionTimeout property (java.lang.Integer) value.
Returns:
java.lang.Integer - The executionTimeout property value.
See Also:
setExecutionTimeout(java.lang.Integer)

getInteractionVerb

public java.lang.Integer getInteractionVerb()
Gets the interactionVerb property (java.lang.Integer) value.
Returns:
java.lang.Integer - The interactionVerb property value.
See Also:
setInteractionVerb(java.lang.Integer)

getKeyName

public java.lang.String getKeyName()
Gets the keyName property (java.lang.String) value.
Returns:
java.lang.String - The keyName property value.
See Also:
setKeyName(java.lang.String)

getRecognizeColumn

public java.lang.Integer getRecognizeColumn()
Gets the recognizeColumn property (java.lang.Integer) value.
Returns:
java.lang.Integer - The recognizeColumn property value.
See Also:
setRecognizeColumn(java.lang.Integer)

getRecognizeRow

public java.lang.Integer getRecognizeRow()
Gets the recognizeRow property (java.lang.Integer) value.
Returns:
java.lang.Integer - The recognizeRow property value.
See Also:
setRecognizeRow(java.lang.Integer)

getRecognizeString

public java.lang.String getRecognizeString()
Gets the recognizeString property (java.lang.String) value.
Returns:
java.lang.String - The recognizeString property value.
See Also:
setRecognizeString(java.lang.String)

getScreenDescriptors

public java.util.Vector getScreenDescriptors()
Gets the screenDescriptors property (java.util.Vector) value.
Returns:
java.util.Vector - The screenDescriptors property value.
See Also:
setScreenDescriptors(java.util.Vector)

getScreenName

public java.lang.String getScreenName()
Gets the screenName property (java.lang.String) value.
Returns:
java.lang.String - The screenName property value.
See Also:
setScreenName(java.lang.String)

getWaitTime

public java.lang.Integer getWaitTime()
Gets the waitTime property (java.lang.Integer) value.
Returns:
java.lang.Integer - The waitTime property value.
See Also:
setWaitTime(java.lang.Integer)

setCursorColumn

public void setCursorColumn(java.lang.Integer cursorColumn)
Sets the cursorColumn property (java.lang.Integer) value for the column coordinate of cursor position.
Parameters:
cursorColumn - java.lang.Integer - The new value for the property.
See Also:
getCursorColumn()

setCursorRecognizeColumn

public void setCursorRecognizeColumn(java.lang.Integer cursorRecognizeColumn)
Sets the cursorRecognizeColumn property (java.lang.Integer) value for the column coordinate of a string to be recognized.
Parameters:
cursorRecognizeColumn - java.lang.Integer - The new value for the property.
See Also:
getCursorRecognizeColumn()

setCursorRecognizeRow

public void setCursorRecognizeRow(java.lang.Integer cursorRecognizeRow)
Sets the cursorRecognizeRow property (java.lang.Integer) value for the row coordinate of a string to be recognized.
Parameters:
cursorRecognizeRow - java.lang.Integer - The new value for the property.
See Also:
getCursorRecognizeRow()

setCursorRow

public void setCursorRow(java.lang.Integer cursorRow)
Sets the cursorRow property (java.lang.Integer) value for the row coordinate of cursor position.
Parameters:
cursorRow - java.lang.Integer - The new value for the property.
See Also:
getCursorRow()

setExecutionTimeout

public void setExecutionTimeout(java.lang.Integer executionTimeout)
Sets the executionTimeout property (java.lang.Integer) value for entire interaction process.
Parameters:
executionTimeout - java.lang.Integer - The new value for the property.
See Also:
getExecutionTimeout()

setInteractionVerb

public void setInteractionVerb(java.lang.Integer interactionVerb)
Sets the interactionVerb property (java.lang.Integer) value to allow send and/or receive data.
Parameters:
interactionVerb - java.lang.Integer - The new value for the property.
See Also:
getInteractionVerb()

setKeyName

public void setKeyName(java.lang.String keyName)
Sets the keyName property (java.lang.String) value.
Parameters:
keyName - java.lang.String - The new value for the property.
See Also:
getKeyName()

setRecognizeColumn

public void setRecognizeColumn(java.lang.Integer recognizeColumn)
Sets the recognizeColumn property (java.lang.Integer) value.
Parameters:
recognizeColumn - java.lang.Integer - The new value for the property.
See Also:
getRecognizeColumn()

setRecognizeRow

public void setRecognizeRow(java.lang.Integer recognizeRow)
Sets the recognizeRow property (java.lang.Integer) value.
Parameters:
recognizeRow - java.lang.Integer - The new value for the property.
See Also:
getRecognizeRow()

setRecognizeString

public void setRecognizeString(java.lang.String recognizeString)
Sets the recognizeString property (java.lang.String) value.
Parameters:
recognizeString - java.lang.String - The new value for the property.
See Also:
getRecognizeString()

setScreenDescriptors

public void setScreenDescriptors(java.util.Vector screenDescriptors)
Sets the screenDescriptors property (java.util.Vector) value.
Parameters:
screenDescriptors - java.util.Vector - The new value for the property.
See Also:
getScreenDescriptors()

setScreenName

public void setScreenName(java.lang.String screenName)
Sets the screenName property (java.lang.String) value.
Parameters:
screenName - java.lang.String - The new value for the property.
See Also:
getScreenName()

setWaitTime

public void setWaitTime(java.lang.Integer waitTime)
Sets the waitTime property (java.lang.Integer) value to allow additional delay for host updates.
Parameters:
waitTime - java.lang.Integer - The new value for the property.
See Also:
getWaitTime()