Services Builder for CICS(R) 3270 Bridge v2.0.0.0

com.attachmate.cicsbridge.j2ee.resource.cci
Interface IBridgeAPI

All Superinterfaces:
javax.resource.cci.Connection

public interface IBridgeAPI
extends javax.resource.cci.Connection

BridgeAPI is a Java interface object which provides access to CICS transaction resources via the CICS Bridge. Methods exposed are based on the Attachmate QACOM api set, with extensions for the CICS Bridge and its capabilities.


Field Summary
static int MODEL_2
          Constant value representing 3270 Model 2 terminal type.
static int MODEL_3
          Constant value representing 3270 Model 3 terminal type.
static int MODEL_4
          Constant value representing 3270 Model 4 terminal type.
static int MODEL_5
          Constant value representing 3270 Model 5 terminal type.
 
Method Summary
 int changePassword(java.lang.String hostIP, int hostPort, java.lang.String userId, java.lang.String password, java.lang.String newPassword)
          Changes the password for a given userId.
 int connectBridge(java.lang.String hostIP, int hostPort, int terminalModel, java.lang.String userid, java.lang.String password)
          Obtains a session state context from the host data engine.
 int connectBridge(java.lang.String hostIP, int hostPort, int terminalModel, java.lang.String userid, java.lang.String password, java.lang.String terminalPoolName)
          Obtains a session state context from the host data engine.
 int connectBridge(java.lang.String hostIP, int hostPort, int terminalModel, java.lang.String userid, java.lang.String password, java.lang.String terminalPoolName, java.lang.String networkName)
          Obtains a session state context from the host data engine.
 int connectBridge(java.lang.String hostIP, int hostPort, int terminalModel, java.lang.String userid, java.lang.String password, java.lang.String terminalPoolName, java.lang.String networkName, java.lang.String terminalFacilityLike)
          Obtains a session state context from the host data engine.
 int disconnect()
          Disconnects the session, releasing the session state context from the host data engine.
 FindString findString(int inScreen, java.lang.String inString, int inStartRow, int inStartColumn, int inFlags)
          Attempts to locate a given string on the current screen, beginning at a specified row and column position.
 FindString findString(java.lang.String inScreen, java.lang.String inString, int inStartRow, int inStartColumn, int inFlags)
          Attempts to locate a given string on the current screen, beginning at a specified row and column position.
 AllFieldInformation getAllFieldInformation(int inScreen, boolean includeColorInfo)
          Retrieves the information of all fields on the current screen.
 AllFieldInformation getAllFieldInformation(java.lang.String inScreen, boolean includeColorInfo)
          Retrieves the information of all fields on the current screen.
 ConnectionStatus getConnectionStatus()
          Returns the status of the host connection.
 CurrentScreenName getCurrentScreenName(int inTimeOut)
          Returns the name of the current host screen.
 CursorPosition getCursorPosition()
          Retrieves the cursor position on the current host screen.
 FieldAttributes getFieldAttributes(int inScreen, int inField)
          Retrieves the attributes of a specified field on the current screen.
 FieldAttributes getFieldAttributes(int inScreen, java.lang.String inField)
          Retrieves the attributes of a specified field on the current screen.
 FieldAttributes getFieldAttributes(java.lang.String inScreen, int inField)
          Retrieves the attributes of a specified field on the current screen.
 FieldAttributes getFieldAttributes(java.lang.String inScreen, java.lang.String inField)
          Retrieves the attributes of a specified field on the current screen.
 FieldCoordinates getFieldCoordinates(int inScreen, int inField)
          Retrieves the coordinates (row, column, and length) of a specified field on the current screen.
 FieldCoordinates getFieldCoordinates(int inScreen, java.lang.String inField)
          Retrieves the coordinates (row, column, and length) of a specified field on the current screen.
 FieldCoordinates getFieldCoordinates(java.lang.String inScreen, int inField)
          Retrieves the coordinates (row, column, and length) of a specified field on the current screen.
 FieldCoordinates getFieldCoordinates(java.lang.String inScreen, java.lang.String inField)
          Retrieves the coordinates (row, column, and length) of a specified field on the current screen.
 FieldCount getFieldCount(int inScreen)
          Retrieves the coordinates (row, column, and length) of a specified field on the current screen.
 FieldCount getFieldCount(java.lang.String inScreen)
          Retrieves the coordinates (row, column, and length) of a specified field on the current screen.
 FieldName getFieldNameFromIndex(int inScreen, int inFieldIndex)
          Retrieves the field name based on its index on the current screen.
 FieldName getFieldNameFromIndex(java.lang.String inScreen, int inFieldIndex)
          Retrieves the field name based on its index on the current screen.
 FieldValue getFieldValue(int inScreen, int inField)
          Retrieves the value of the specified field on the current screen.
 FieldValue getFieldValue(int inScreen, java.lang.String inField)
          Retrieves the value of the specified field on the current screen.
 FieldValue getFieldValue(java.lang.String inScreen, int inField)
          Retrieves the value of the specified field on the current screen.
 FieldValue getFieldValue(java.lang.String inScreen, java.lang.String inField)
          Retrieves the value of the specified field on the current screen.
 java.lang.String getReturnCodeMessage(int returnCode)
          Returns a String explanation of a known error code.
 ScreenSize getScreenSize(int inScreen)
          Retrieves the size of the current screen.
 ScreenSize getScreenSize(java.lang.String inScreen)
          Retrieves the size of the current screen.
 GetString getString(int inScreen, int inStartRow, int inStartColumn, int inLength)
          Retrieves any text on the current screen at the specified row, column, and length.
 GetString getString(java.lang.String inScreen, int inStartRow, int inStartColumn, int inLength)
          Retrieves any text on the current screen at the specified row, column, and length.
 TransactionSystemId getTransactionSystemId(java.lang.String inHostIP, int inHostPort, java.lang.String inTransactionId)
          Get a text string containing the name of the CICS System Id (outSystemId) in which a given transaction Id (inTransactionId) executes.
 PutString putString(java.lang.String inText, int inRow, int inColumn)
          Writes text to the session presentation space beginning at the row and column specified.
 int sendKeys(java.lang.String inKeys)
          Writes text to the session presentation space beginning at the current cursor position.
 int sendKeysEx(java.lang.String inKeys)
          This method is included for backward compatibility only.
 AllFieldInformation sendKeysGetAllFieldInformation(java.lang.String inKeys)
          Retrieves the information of all fields on the current screen.
 GetString sendKeysGetString(java.lang.String inKeys, int inStartRow, int inStartColumn, int inLength)
          Sends a sequence of keystrokes and aid keys to the host and retrieves any text on the current screen at the specified row, column, and length.
 int setCursorPosition(int inRow, int inColumn)
          Sets the cursor position on the current host screen.
 int setFieldValue(int inField, java.lang.String inValue)
          Sets the value of the specified unprotected field on the current screen.
 int setFieldValue(java.lang.String[] inFields, java.lang.String[] inValues)
          Sets the value of an array of specified unprotected fields on the current screen with a single call.
 int setFieldValue(java.lang.String inField, java.lang.String inValue)
          Sets the value of the specified unprotected field on the current screen.
 int setSettleTime(int inSettleTime)
          This method is included for backward compatibility only.
 int setTimeOut(int inTimeOut)
          This method is included for backward compatibility only.
 int setTraceActive(java.lang.String inTraceQueueName)
          Start CICS 3270 Bridge Vector trace and optionally pass in a trace Temporary Storage queue name.
 int setTraceInactive()
          Stop CICS 3270 Bridge Vector trace.
 int setTraceName(java.lang.String inTraceQueueName)
          Set name of CICS 3270 Bridge Vector trace for this session.
 int terminate()
          This method is included for backward compatibility only.
 
Methods inherited from interface javax.resource.cci.Connection
close, createInteraction, getLocalTransaction, getMetaData, getResultSetInfo
 

Field Detail

MODEL_2

public static final int MODEL_2
Constant value representing 3270 Model 2 terminal type.

See Also:
Constant Field Values

MODEL_3

public static final int MODEL_3
Constant value representing 3270 Model 3 terminal type.

See Also:
Constant Field Values

MODEL_4

public static final int MODEL_4
Constant value representing 3270 Model 4 terminal type.

See Also:
Constant Field Values

MODEL_5

public static final int MODEL_5
Constant value representing 3270 Model 5 terminal type.

See Also:
Constant Field Values
Method Detail

getReturnCodeMessage

public java.lang.String getReturnCodeMessage(int returnCode)
                                      throws javax.resource.ResourceException
Returns a String explanation of a known error code.

Parameters:
returnCode - - int value of return code obtained from a BridgeAPI method call.
Returns:
String with brief explanation of the error encountered. Possible values, meanings:
   Return Code     Meaning

     (Successful completion with no error)
     0             Successful execution no errors encountered.

     (Errors that occurred on the client side)
     -5            Invalid parameter supplied to method
     -6            Error in sending message to Host CICS
     -8            Missing parameter object.
     -9            Invalid terminal model.
    -15            No Content-Length token in mainframe response.
    -30            No "HTTP/1.0 200 OK" token found in mainframe response.
    -35            API function requesting other than the current screen. 
    -37            No field name supplied.
    -39            Invalid field index value.
    -40            Screen name greater than 255 characters.
    -70            No SetField field data supplied.	
    -85            85 Unsuccessful TERMID check out from pool.

     (Errors that occurred on the CICS side)
    200            CICS COMMAREA HAD A LENGTH OF ZERO AT THE START
    201            UNRECOGNIZED REQUEST FUNCTION CODE IN COMMAREA
    202            UNRECOGNIZED EYECATCHER IN REQUEST COMMAREA
    210            INQUIRE TERMINAL FOR CASE FAILED FOR CONNECT
    212            INQUIRE TERMINAL FOR CONVERSE FAILED
    214            INQUIRE TERMINAL FAILED
    215            TERMINAL ID IN USE
    320            TERMINAL MODEL NUMBER IN CONNECT REQUEST WAS INVALID
    330            BUFFER SIZE FROM SESSION STATE IS NOT A VALID BUFFSIZE
    340            USER ID/PASSWORD COMBINATION INVALID
    401            CICS GETMAIN FOR MSG Q STAGING AREA FAILED
    410            CICS GETMAIN FOR REPLY VECTOR FAILED
    460            CICS GETMAIN FOR CREATION OF SESSION STATE DATA FAILED
    461            CICS GETMAIN FOR CREATION OF MSG AND REPLY ECBS FAILED
    470            CICS GETMAIN TO HOLD SESSION STATE DATA FAILED
    600            CICS WRITE TO THE BRIDGE MSG TSQ RESOURCE FAILED
    610            CICS WRITE TO THE SESSION STATE Q RESOURCE FAILED
    620            CICS READ OF THE BRIDGE REPLY TSQ RESOURCE FAILED
    650            CICS READ OF THE STATE TSQ RESOURCE FAILED
    651            REQUESTED SESSION IS NOT ACTIVE OR VALID
    700            CICS START APPLICATION TRAN(xxxx) WITH BRIDGE FAILED
    710            TIMEOUT ON A READ OF THE BRIDGE REPLYQ
    715            BRIDGE EXIT DETECTED FAILURE WHILE PROCESSING TRANSACTION
    718            TRANSACTION INQUIRY FAILED
    755            TRACE REQUEST QNAME IS INVALID
    760            HOST APPLICATION ISSUED AN EXPLICIT ROLLBACK
    800            UNRECOG BRIDGE REQUEST VECTOR RETURNED IN REPLY Q DATA
    801            UNHANDLED BRIDGE VECTOR:  VECTOR = xxxx
    810            UNRECOG METHOD CODE FOR GET SECURITY INFO IN CONNECT
    999            UNEXPECTED OR UNKNOWN ERROR CONDITION
   1001            CICS START OF CLEANUP TRAN(xxxx) FAILED
   1002            CICS CANCEL OF STARTED ICE FAILED
   1003            CICS RETRIEVE OF DATA ASSOC WITH ICE START, FAILED
   1010            INVALID FINDSTRING SCREEN,ROW,COL,STRING COMBINATION
   1100            CICS SEND MAP WITH MAPPINGDEV AND FRSET FAILED
   1110            CICS SEND MAP WITH MAPPINGDEV NO FRSET FAILED
   1120            CICS SEND MAP FOR CESN WITH MAPPINGDEV NO FRSET FAILED
   1200            CICS LOAD PROGRAM WITH MAPSET FAILED
   1210            CICS RELEASE PROGRAM WITH MAPSET FAILED
   1300            SENDKEYS STRING LENGTH = ZERO.
   1301            INVALID SCREEN INDEX OR SCREEN NAME VALUE
   1302            PUTSTRING -> PUTSTRINGEX TO VCUT DISPLAY BUFFER FAILED
   1303            PUTSTRINGEX TO VCUT DISPLAY BUFFER FAILED
   1304            SENDKEYS PUTSTRING TO VCUT DISPLAY BUFFER FAILED
   1305            SENDKEYS STRING INVALID, ENDED WITH A SINGLE ESC CHAR
   1306            UNEXPECTED OR UNKNOWN REQUEST FUNCTION
   1307            INVALID GETSTRING ROW,COL,LEN COMBINATION FOR MODEL
   1308            RENDER OF AID KEY IN VCUT DISPLAY BUFFER FAILED
   1309            PUTSTRING REQUEST ROW IS INVALID FOR MODEL
   1310            PUTSTRING REQUEST COL IS INVALID FOR MODEL
   1311            PUTSTRING TEXT LENGTH INVALID FOR MODEL BUFFER SIZE
   1312            GET FIELD INFORMATION FAILED
   1313            SET FIELD VALUE FAILED
   1314            GET ALL FIELD INFORMATION FAILED
   1320            FIELDCOUNT FAILED
   1321            FINDFIELD FAILED
   1322            FINDSTRING FAILED
   1323            INVALID ROW, COL, POSITION COMBINATION FOR REQUEST
   1326            GETATTRIBUTES FAILED
   1327            GETSTRINGEX FAILED FOR PASSWORD
   1328            GETSTRINGEX FAILED FOR USERID
   1400            CICS verification failure message from the External Security Manager, in this format:
     (See the execution tracelog, System.out, or console for more details)
        CICS VERIFY: INVALID USERID            ESMREASON=numberESMRESP=number
        CICS VERIFY: INVALID PASSWORD          ESMREASON=numberESMRESP=number
        CICS VERIFY: UNKNOWN RET FROM THE ESM: ESMREASON=numberESMRESP=number
        CICS VERIFY: ESM INTERFACE IS NOT INIT ESMREASON=numberESMRESP=number
        CICS VERIFY: ESM NOT RESPONDING:       ESMREASON=numberESMRESP=number
        CICS VERIFY: NEW PASSWORD IS REQUIRED: ESMREASON=numberESMRESP=number
        CICS VERIFY: THE USERID IS REVOKED:    ESMREASON=numberESMRESP=number
        CICS VERIFY: UNKNOWN RESP CODE:        ESMREASON=numberESMRESP=number
        CICS VERIFY: UNKNOWN RESP2 CODE:       ESMREASON=numberESMRESP=number
   1402            CICS Verification failed with External Security Manager: INVALID_PASSWORD
   1403            CICS Verification failed with External Security Manager: NEW_PASSWORD_REQUIRED
   1404            CICS Verification failed with External Security Manager: NEW_PASSWORD_NOT_ACCEPTABLE
   1408            CICS Verification failed with External Security Manager: UNKNOWN_USERID
   1419            CICS Verification failed with External Security Manager: USERID_REVOKED
   1432            CICS Verification failed with External Security Manager: USERID_CONTAINS_BLANK
   1497            CICS Verification failed with External Security Manager: USERID_MISSING
   1498            CICS Verification failed with External Security Manager: PASSWORD_MISSING
   1499            CICS Verification failed with External Security Manager: NEW_PASSWORD_MISSING

     (Errors that occurred calling the Linkable Bridge)
 
   91020         CREATE - TERMID FROM AUTOINSTALL IS INVALID 
   91021         CREATE - NETNAME FROM AUTOINSTALL IS INVALID 
   91022         CREATE - AUTOINSTALL URM REJECTED BRIDGE INSTALL REQUEST 
   91023         CREATE - LINK TO AUTOINSTALL URM FAILED 
   91024         CREATE - SUPPLIED NETNAME INVALID 
   91025         CREATE - SUPPLIED TERMID INVALID 
   91026         CREATE - SUPPLIED FACILITYLIKE INVALID
   91040         CREATE - LINK TO THE DYNAMIC ROUTING URM 
   91041         CREATE - BRIDGE ROUTING REQUEST REJECTED BY THE DYNAMIC ROUTING URM 
   91042         CREATE - THE TRANSACTION DEFINITION DOES NOT ALLOW IT TO BE ROUTED TO THE REQUESTED REGION. 
   91043         CREATE - TRANSACTION REQUEST COULD NOT BE ROUTED TO THE REMOTE REGION DUE TO A CONNECTION ERROR.
   91044         CREATE - LINK TO AOR FAILED WITH TERMERR 
   91045         CREATE - REQUEST WAS ROUTED TO A BACK LEVEL CICS THAT DOES NOT SUPPORT LINKABLE BRIDGE
   91061         CREATE - INVALID FACILITYTOKEN SUPPLIED IN BRIDGE HEADER INFORMATION
   91062         CREATE - ALL BRIDGE FACILITIES ARE ALLOCATED
   91063         CREATE - THIS FACILITYTOKEN IS IN USE
   91064         CREATE - NOT ENOUGH STORAGE TO RUN REQUEST IN ROUTER REGION OR APPLICATION OWNING REGION
   91065         CREATE - FILE DFHBRNSF IS UNAVAILABLE OR HAS NOT BEEN DEFINED
   91066         CREATE - THE CICS REGION IS TERMINATING, PROCESSING REQUEST REJECTED
   91080         CREATE - TRANSACTION NOT ENABLED TO RUN AT SHUTDOWN
   91082         CREATE - TRANSACTION CAN ONLY BE SYSTEM ATTACHED, NOT VALID UNDER THE BRIDGE
   91084         CREATE - TRANSACTION IS DISABLED
   91085         CREATE - TRANSACTION IS NOT FOUND
   91086         CREATE - TRANSACTION IS NOT RUNNING ON BRIDGE FACILITY
   91087         CREATE - TRANSACTION PROFILE IS NOT FOUND
   91100         CREATE - USERID IN SESSION REQUEST DIFFERENT THAN USERID SUPPLIED TO ALLOCATE THE BRIDGE FACILITY
   91120         CREATE - THE GET MORE DATA REQUEST FAILED BECAUSE THERE WAS NO MORE DATA
   91121         CREATE - RETRIEVE VECTORS NOT SUPPORTED AFTER INITIAL REQUEST
   91140         CREATE - INVALID DATA LENGTH SPECIFIED IN BRIDGE HEADER          
   91141         CREATE - VECTOR IS INVALID          
   91142         CREATE - ALLOCATE FACILITY REQUEST CONTAINED AN INVALID KEEPTIME OF ZERO    
   91143         CREATE - MESSAGE CONTAINS NO VECTORS: CONTINUE REQUEST IS INVALID
   91160         CREATE - TARGET CICS 3270 APPLICATION ABEND
   92020         LINK   - TERMID FROM AUTOINSTALL IS INVALID 
   92021         LINK   - NETNAME FROM AUTOINSTALL IS INVALID 
   92022         LINK   - AUTOINSTALL URM REJECTED BRIDGE INSTALL REQUEST 
   92023         LINK   - LINK TO AUTOINSTALL URM FAILED 
   92024         LINK   - SUPPLIED NETNAME INVALID 
   92025         LINK   - SUPPLIED TERMID INVALID 
   92026         LINK   - SUPPLIED FACILITYLIKE INVALID
   92040         LINK   - LINK TO THE DYNAMIC ROUTING URM 
   92041         LINK   - BRIDGE ROUTING REQUEST REJECTED BY THE DYNAMIC ROUTING URM 
   92042         LINK   - THE TRANSACTION DEFINITION DOES NOT ALLOW IT TO BE ROUTED TO THE REQUESTED REGION. 
   92043         LINK   - TRANSACTION REQUEST COULD NOT BE ROUTED TO THE REMOTE REGION DUE TO A CONNECTION ERROR.
   92044         LINK   - LINK TO AOR FAILED WITH TERMERR 
   92045         LINK   - REQUEST WAS ROUTED TO A BACK LEVEL CICS THAT DOES NOT SUPPORT LINKABLE BRIDGE
   92061         LINK   - INVALID FACILITYTOKEN SUPPLIED IN BRIDGE HEADER INFORMATION
   92062         LINK   - ALL BRIDGE FACILITIES ARE ALLOCATED
   92063         LINK   - THIS FACILITYTOKEN IS IN USE
   92064         LINK   - NOT ENOUGH STORAGE TO RUN REQUEST IN ROUTER REGION OR APPLICATION OWNING REGION
   92065         LINK   - FILE DFHBRNSF IS UNAVAILABLE OR HAS NOT BEEN DEFINED
   92066         LINK   - THE CICS REGION IS TERMINATING, PROCESSING REQUEST REJECTED
   92080         LINK   - TRANSACTION NOT ENABLED TO RUN AT SHUTDOWN
   92082         LINK   - TRANSACTION CAN ONLY BE SYSTEM ATTACHED, NOT VALID UNDER THE BRIDGE
   92084         LINK   - TRANSACTION IS DISABLED
   92085         LINK   - TRANSACTION IS NOT FOUND
   92086         LINK   - TRANSACTION IS NOT RUNNING ON BRIDGE FACILITY
   92087         LINK   - TRANSACTION PROFILE IS NOT FOUND
   92100         LINK   - USERID IN SESSION REQUEST DIFFERENT THAN USERID SUPPLIED TO ALLOCATE THE BRIDGE FACILITY
   92120         LINK   - THE GET MORE DATA REQUEST FAILED BECAUSE THERE WAS NO MORE DATA
   92121         LINK   - RETRIEVE VECTORS NOT SUPPORTED AFTER INITIAL REQUEST
   92140         LINK   - INVALID DATA LENGTH SPECIFIED IN BRIDGE HEADER          
   92141         LINK   - VECTOR IS INVALID          
   92142         LINK   - ALLOCATE FACILITY REQUEST CONTAINED AN INVALID KEEPTIME OF ZERO    
   92143         LINK   - MESSAGE CONTAINS NO VECTORS: CONTINUE REQUEST IS INVALID
   92160         LINK   - TARGET CICS 3270 APPLICATION ABEND
   93020         DELETE - TERMID FROM AUTOINSTALL IS INVALID 
   93021         DELETE - NETNAME FROM AUTOINSTALL IS INVALID 
   93022         DELETE - AUTOINSTALL URM REJECTED BRIDGE INSTALL REQUEST 
   93023         DELETE - LINK TO AUTOINSTALL URM FAILED 
   93024         DELETE - SUPPLIED NETNAME INVALID 
   93025         DELETE - SUPPLIED TERMID INVALID 
   93026         DELETE - SUPPLIED FACILITYLIKE INVALID
   93040         DELETE - LINK TO THE DYNAMIC ROUTING URM 
   93041         DELETE - BRIDGE ROUTING REQUEST REJECTED BY THE DYNAMIC ROUTING URM 
   93042         DELETE - THE TRANSACTION DEFINITION DOES NOT ALLOW IT TO BE ROUTED TO THE REQUESTED REGION. 
   93043         DELETE - TRANSACTION REQUEST COULD NOT BE ROUTED TO THE REMOTE REGION DUE TO A CONNECTION ERROR.
   93044         DELETE - LINK TO AOR FAILED WITH TERMERR 
   93045         DELETE - REQUEST WAS ROUTED TO A BACK LEVEL CICS THAT DOES NOT SUPPORT LINKABLE BRIDGE
   93061         DELETE - INVALID FACILITYTOKEN SUPPLIED IN BRIDGE HEADER INFORMATION
   93062         DELETE - ALL BRIDGE FACILITIES ARE ALLOCATED
   93063         DELETE - THIS FACILITYTOKEN IS IN USE
   93064         DELETE - NOT ENOUGH STORAGE TO RUN REQUEST IN ROUTER REGION OR APPLICATION OWNING REGION
   93065         DELETE - FILE DFHBRNSF IS UNAVAILABLE OR HAS NOT BEEN DEFINED
   93066         DELETE - THE CICS REGION IS TERMINATING, PROCESSING REQUEST REJECTED
   93080         DELETE - TRANSACTION NOT ENABLED TO RUN AT SHUTDOWN
   93082         DELETE - TRANSACTION CAN ONLY BE SYSTEM ATTACHED, NOT VALID UNDER THE BRIDGE
   93084         DELETE - TRANSACTION IS DISABLED
   93085         DELETE - TRANSACTION IS NOT FOUND
   93086         DELETE - TRANSACTION IS NOT RUNNING ON BRIDGE FACILITY
   93087         DELETE - TRANSACTION PROFILE IS NOT FOUND
   93100         DELETE - USERID IN SESSION REQUEST DIFFERENT THAN USERID SUPPLIED TO ALLOCATE THE BRIDGE FACILITY
   93120         DELETE - THE GET MORE DATA REQUEST FAILED BECAUSE THERE WAS NO MORE DATA
   93121         DELETE - RETRIEVE VECTORS NOT SUPPORTED AFTER INITIAL REQUEST
   93140         DELETE - INVALID DATA LENGTH SPECIFIED IN BRIDGE HEADER          
   93141         DELETE - VECTOR IS INVALID          
   93142         DELETE - ALLOCATE FACILITY REQUEST CONTAINED AN INVALID KEEPTIME OF ZERO    
   93143         DELETE - MESSAGE CONTAINS NO VECTORS: CONTINUE REQUEST IS INVALID
   93160         DELETE - TARGET CICS 3270 APPLICATION ABEND
 
Throws:
javax.resource.ResourceException

changePassword

public int changePassword(java.lang.String hostIP,
                          int hostPort,
                          java.lang.String userId,
                          java.lang.String password,
                          java.lang.String newPassword)
                   throws javax.resource.ResourceException
Changes the password for a given userId. The userId, encrypted password, and encrypted newPassword are sent to the host. If the password is correct for the userId then the new password is set as the valid password for this userId.

Parameters:
hostIP - - String with IP address of target CICS region in the form of nnn.nnn.nnn.nnn.
hostPort - - integer TCP port address of target CICS region.
userId - - String containing user identification one to eight bytes in length.
password - - String existing password one to eight bytes in length for the given userId.
newPassword - - String proposed new password one to eight bytes in length to use for the given userId.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
javax.resource.ResourceException

connectBridge

public int connectBridge(java.lang.String hostIP,
                         int hostPort,
                         int terminalModel,
                         java.lang.String userid,
                         java.lang.String password)
                  throws javax.resource.ResourceException
Obtains a session state context from the host data engine. If the destination CICS region requires a CESN sign-on and the connectBridge does not pass a valid UserId and Password, the 3270 session is presented with the CESN sign-on screen upon completing the connectBridge. If a valid UserId and Password are passed in on the connectBridge, the user is Authenticated without requiring a separate CESN logon. Upon completion of a successful connectBridge featuring a valid UserId and Password, the session is at a clear screen, ready for a transaction to be initiated by the user.

Parameters:
hostIP - - Text format IP address of the target host CICS region (for example, '234.164.88.1').
hostPort - - Port corresponding to the target CICS region.
terminalModel - - 3270 terminal model type (valid values: 2 for Model 2, 3 for Model 3, 4 for Model 4, 5 for Model 5).
userid - - The user ID for the host data engine to use with the External Security Manager on behalf of this session. If no userid is desired, use a null string or spaces.
password - - The password for the host data engine to use with the External Security Manager on behalf of this session. If no userid is desired, use a null string or spaces.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
javax.resource.ResourceException

connectBridge

public int connectBridge(java.lang.String hostIP,
                         int hostPort,
                         int terminalModel,
                         java.lang.String userid,
                         java.lang.String password,
                         java.lang.String terminalPoolName)
                  throws javax.resource.ResourceException
Obtains a session state context from the host data engine. If the destination CICS region requires a CESN sign-on and the connectBridge does not pass a valid UserId and Password, the 3270 session is presented with the CESN sign-on screen upon completing the connectBridge. If a valid UserId and Password are passed in on the connectBridge, the user is Authenticated without requiring a separate CESN logon. Upon completion of a successful connectBridge featuring a valid UserId and Password, the session is at a clear screen, ready for a transaction to be initiated by the user.

Parameters:
hostIP - - Text format IP address of the target host CICS region (for example, '234.164.88.1').
hostPort - - Port corresponding to the target CICS region.
terminalModel - - 3270 terminal model type (valid values: 2 for Model 2, 3 for Model 3, 4 for Model 4, 5 for Model 5).
userid - - The user ID for the host data engine to use with the External Security Manager on behalf of this session. If no userid is desired, use a null string or spaces.
password - - The password for the host data engine to use with the External Security Manager on behalf of this session. If no userid is desired, use a null string or spaces.
terminalPoolName - - The terminal pool name from which to draw the desired 3270 connection. If no particular pool is desired, use a null string or spaces.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
javax.resource.ResourceException

connectBridge

public int connectBridge(java.lang.String hostIP,
                         int hostPort,
                         int terminalModel,
                         java.lang.String userid,
                         java.lang.String password,
                         java.lang.String terminalPoolName,
                         java.lang.String networkName)
                  throws javax.resource.ResourceException
Obtains a session state context from the host data engine. If the destination CICS region requires a CESN sign-on and the connectBridge does not pass a valid UserId and Password, the 3270 session is presented with the CESN sign-on screen upon completing the connectBridge. If a valid UserId and Password are passed in on the connectBridge, the user is Authenticated without requiring a separate CESN logon. Upon completion of a successful connectBridge featuring a valid UserId and Password, the session is at a clear screen, ready for a transaction to be initiated by the user.

Parameters:
hostIP - - Text format IP address of the target host CICS region (for example, '234.164.88.1').
hostPort - - Port corresponding to the target CICS region.
terminalModel - - 3270 terminal model type (valid values: 2 for Model 2, 3 for Model 3, 4 for Model 4, 5 for Model 5).
userid - - The user ID for the host data engine to use with the External Security Manager on behalf of this session. If no userid is desired, use a null string or spaces.
password - - The password for the host data engine to use with the External Security Manager on behalf of this session. If no userid is desired, use a null string or spaces.
terminalPoolName - - The terminal pool name from which to draw the desired 3270 connection. If no particular pool is desired, use a null string or spaces.
networkName - - The one to eight character to be assigned to the pseudo LU for the new connection. To use default name for this connection, use a null or spaces.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
javax.resource.ResourceException

connectBridge

public int connectBridge(java.lang.String hostIP,
                         int hostPort,
                         int terminalModel,
                         java.lang.String userid,
                         java.lang.String password,
                         java.lang.String terminalPoolName,
                         java.lang.String networkName,
                         java.lang.String terminalFacilityLike)
                  throws javax.resource.ResourceException
Obtains a session state context from the host data engine. If the destination CICS region requires a CESN sign-on and the connectBridge does not pass a valid UserId and Password, the 3270 session is presented with the CESN sign-on screen upon completing the connectBridge. If a valid UserId and Password are passed in on the connectBridge, the user is Authenticated without requiring a separate CESN logon. Upon completion of a successful connectBridge featuring a valid UserId and Password, the session is at a clear screen, ready for a transaction to be initiated by the user.

Parameters:
hostIP - - Text format IP address of the target host CICS region (for example, '234.164.88.1').
hostPort - - Port corresponding to the target CICS region.
terminalModel - - 3270 terminal model type (valid values: 2 for Model 2, 3 for Model 3, 4 for Model 4, 5 for Model 5).
userid - - The user ID for the host data engine to use with the External Security Manager on behalf of this session. If no userid is desired, use a null string or spaces.
password - - The password for the host data engine to use with the External Security Manager on behalf of this session. If no userid is desired, use a null string or spaces.
terminalPoolName - - The terminal pool name from which to draw the desired 3270 connection. If no particular pool is desired, use a null string or spaces.
networkName - - The one to eight character to be assigned to the pseudo LU for the new connection. To use default name for this connection, use a null or spaces.
terminalFacilityLike - - The optional text format IP address of the requesting client. To omit client IP address, use a null string or spaces.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
javax.resource.ResourceException

disconnect

public int disconnect()
               throws javax.resource.ResourceException
Disconnects the session, releasing the session state context from the host data engine.

Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
javax.resource.ResourceException

findString

public FindString findString(int inScreen,
                             java.lang.String inString,
                             int inStartRow,
                             int inStartColumn,
                             int inFlags)
                      throws javax.resource.ResourceException
Attempts to locate a given string on the current screen, beginning at a specified row and column position.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inString - - The string to search for on the current screen.
inStartRow - - The row position at which to start the search. This parameter must be greater than or equal to 1.
inStartColumn - - The column position at which to start the search. This parameter must be greater than or equal to 1.
inFlags - - Flags that control the method's behavior. The flags can be a combination of the following values:
  1    :  The findString method wraps to the beginning of the screen or field after reaching the end.
  2    :  The findString method searches backward.
  4    :  The findString method searches only in the field that contains the specified row and column.  All other flags apply only within the field.  The search begins at the point in the field specified by the inRow and inColumn parameters.  The outRow and outColumn parameters contain the position on the screen where the string is found, or zero if the string is not found.
  8    :  The findString method ignores case when searching for a string.
     NOTE: If you send a zero in the inFlags parameter, this method performs a screen-wide, case-sensitive, non-wrapping, forward search.
 
Returns:
FindString
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

findString

public FindString findString(java.lang.String inScreen,
                             java.lang.String inString,
                             int inStartRow,
                             int inStartColumn,
                             int inFlags)
                      throws javax.resource.ResourceException
Attempts to locate a given string on the current screen, beginning at a specified row and column position.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inString - - The string to search for on the current screen.
inStartRow - - The row position at which to start the search. This parameter must be greater than or equal to 1.
inStartColumn - - The column position at which to start the search. This parameter must be greater than or equal to 1.
inFlags - - Flags that control the method's behavior. The flags can be a combination of the following values:
  1    :  The findString method wraps to the beginning of the screen or field after reaching the end.
  2    :  The findString method searches backward.
  4    :  The findString method searches only in the field that contains the specified row and column.  All other flags apply only within the field.  The search begins at the point in the field specified by the inRow and inColumn parameters.  The outRow and outColumn parameters contain the position on the screen where the string is found, or zero if the string is not found.
  8    :  The findString method ignores case when searching for a string.
     NOTE: If you send a zero in the inFlags parameter, this method performs a screen-wide, case-sensitive, non-wrapping, forward search.
 
Returns:
FindString
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getAllFieldInformation

public AllFieldInformation getAllFieldInformation(int inScreen,
                                                  boolean includeColorInfo)
                                           throws javax.resource.ResourceException
Retrieves the information of all fields on the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
includeColorInfo - - Retrieves reserved for future use to control whether color information included.
Returns:
AllFieldInformation
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getAllFieldInformation

public AllFieldInformation getAllFieldInformation(java.lang.String inScreen,
                                                  boolean includeColorInfo)
                                           throws javax.resource.ResourceException
Retrieves the information of all fields on the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
includeColorInfo - - reserved for future use to control whether color information included.
Returns:
AllFieldInformation
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getConnectionStatus

public ConnectionStatus getConnectionStatus()
                                     throws javax.resource.ResourceException
Returns the status of the host connection.

Returns:
ConnectionStatus
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getCurrentScreenName

public CurrentScreenName getCurrentScreenName(int inTimeOut)
                                       throws javax.resource.ResourceException
Returns the name of the current host screen.

Parameters:
inTimeOut - - In this implementation, this parameter is disregarded. It is included only for backward compatibility.
Returns:
CurrentScreenName
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getCursorPosition

public CursorPosition getCursorPosition()
                                 throws javax.resource.ResourceException
Retrieves the cursor position on the current host screen.

Returns:
CursorPosition
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getFieldAttributes

public FieldAttributes getFieldAttributes(int inScreen,
                                          java.lang.String inField)
                                   throws javax.resource.ResourceException
Retrieves the attributes of a specified field on the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - - The name of the field.
Returns:
FieldAttributes
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getFieldAttributes

public FieldAttributes getFieldAttributes(int inScreen,
                                          int inField)
                                   throws javax.resource.ResourceException
Retrieves the attributes of a specified field on the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - - The zero base index number of the field on the screen.
Returns:
FieldAttributes
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getFieldAttributes

public FieldAttributes getFieldAttributes(java.lang.String inScreen,
                                          int inField)
                                   throws javax.resource.ResourceException
Retrieves the attributes of a specified field on the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - - The zero base index number of the field on the screen.
Returns:
FieldAttributes
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getFieldAttributes

public FieldAttributes getFieldAttributes(java.lang.String inScreen,
                                          java.lang.String inField)
                                   throws javax.resource.ResourceException
Retrieves the attributes of a specified field on the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - - The name of the field.
Returns:
FieldAttributes
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getFieldCoordinates

public FieldCoordinates getFieldCoordinates(int inScreen,
                                            int inField)
                                     throws javax.resource.ResourceException
Retrieves the coordinates (row, column, and length) of a specified field on the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - - The zero-based index of the field for which to get coordinates.
Returns:
FieldCoordinates
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getFieldCoordinates

public FieldCoordinates getFieldCoordinates(java.lang.String inScreen,
                                            java.lang.String inField)
                                     throws javax.resource.ResourceException
Retrieves the coordinates (row, column, and length) of a specified field on the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - - The name of the field for which coordinates are desired.
Returns:
FieldCoordinates
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getFieldCoordinates

public FieldCoordinates getFieldCoordinates(int inScreen,
                                            java.lang.String inField)
                                     throws javax.resource.ResourceException
Retrieves the coordinates (row, column, and length) of a specified field on the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - - The name of the field for which coordinates are desired.
Returns:
FieldCoordinates
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getFieldCoordinates

public FieldCoordinates getFieldCoordinates(java.lang.String inScreen,
                                            int inField)
                                     throws javax.resource.ResourceException
Retrieves the coordinates (row, column, and length) of a specified field on the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - - The zero-based index of the field for which coordinates are desired.
Returns:
FieldCoordinates
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getFieldCount

public FieldCount getFieldCount(int inScreen)
                         throws javax.resource.ResourceException
Retrieves the coordinates (row, column, and length) of a specified field on the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
Returns:
FieldCount
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getFieldCount

public FieldCount getFieldCount(java.lang.String inScreen)
                         throws javax.resource.ResourceException
Retrieves the coordinates (row, column, and length) of a specified field on the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
Returns:
FieldCount
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getFieldNameFromIndex

public FieldName getFieldNameFromIndex(java.lang.String inScreen,
                                       int inFieldIndex)
                                throws javax.resource.ResourceException
Retrieves the field name based on its index on the current screen. The index numbers start at zero and end at 1 less than the field count.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inFieldIndex - - The index number of the field on the screen. The index is zero-based. This number must be less than the number of fields returned in getFieldCount().
Returns:
FieldName
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getFieldNameFromIndex

public FieldName getFieldNameFromIndex(int inScreen,
                                       int inFieldIndex)
                                throws javax.resource.ResourceException
Retrieves the field name based on its index on the current screen. The index numbers start at zero and end at 1 less than the field count.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inFieldIndex - - The index number of the field on the screen. The index is zero-based. This number must be less than the number of fields returned in getFieldCount().
Returns:
FieldName
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getFieldValue

public FieldValue getFieldValue(int inScreen,
                                java.lang.String inField)
                         throws javax.resource.ResourceException
Retrieves the value of the specified field on the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - - The name of the field for which you are requesting a value.
Returns:
FieldValue
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getFieldValue

public FieldValue getFieldValue(int inScreen,
                                int inField)
                         throws javax.resource.ResourceException
Retrieves the value of the specified field on the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - - The zero-based index of the field on the current screen.
Returns:
FieldValue
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getFieldValue

public FieldValue getFieldValue(java.lang.String inScreen,
                                int inField)
                         throws javax.resource.ResourceException
Retrieves the value of the specified field on the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - - The zero-based index of the field on the current screen.
Returns:
FieldValue
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getFieldValue

public FieldValue getFieldValue(java.lang.String inScreen,
                                java.lang.String inField)
                         throws javax.resource.ResourceException
Retrieves the value of the specified field on the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - - The name of the field for which you are requesting a value.
Returns:
FieldValue
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getScreenSize

public ScreenSize getScreenSize(java.lang.String inScreen)
                         throws javax.resource.ResourceException
Retrieves the size of the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
Returns:
ScreenSize
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getScreenSize

public ScreenSize getScreenSize(int inScreen)
                         throws javax.resource.ResourceException
Retrieves the size of the current screen.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
javax.resource.ResourceException

getString

public GetString getString(int inScreen,
                           int inStartRow,
                           int inStartColumn,
                           int inLength)
                    throws javax.resource.ResourceException
Retrieves any text on the current screen at the specified row, column, and length. If the length parameter is zero, getString retrieves text from the specified row and column to the end of the screen. The Row and Column parameters must always be greater than or equal to 1. The getString method returns the correct value even though it is contained in non-display fields. Therefore, be sure to check the field attribute prior to displaying text retrieved with this method.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inStartRow - - The row position on the host screen at which to begin retrieving text.
inStartColumn - - The column position on the host screen at which to begin retrieving text.
inLength - - The length of the text string to be retrieved. If this value is zero, the text is retrieved up to the end of the screen.
Returns:
GetString
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getString

public GetString getString(java.lang.String inScreen,
                           int inStartRow,
                           int inStartColumn,
                           int inLength)
                    throws javax.resource.ResourceException
Retrieves any text on the current screen at the specified row, column, and length. If the length parameter is zero, getString retrieves text from the specified row and column to the end of the screen. The Row and Column parameters must always be greater than or equal to 1. The getString method returns the correct value even though it is contained in non-display fields. Therefore, be sure to check the field attribute prior to displaying text retrieved with this method.

Parameters:
inScreen - - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inStartRow - - The row position on the host screen at which to begin retrieving text.
inStartColumn - - The column position on the host screen at which to begin retrieving text.
inLength - - The length of the text string to be retrieved. If this value is zero, the text is retrieved up to the end of the screen.
Returns:
GetString
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

putString

public PutString putString(java.lang.String inText,
                           int inRow,
                           int inColumn)
                    throws javax.resource.ResourceException
Writes text to the session presentation space beginning at the row and column specified. If a protected field is encountered while writing, characters from the text string are discarded, and writing continues with the next unprotected field.

Parameters:
inText - - The text string to write, beginning at the specified position.
inRow - - The row position on the host screen at which to begin writing the text string.
inColumn - - The column position on the host screen at which to begin writing the text string.
Returns:
PutString
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

getTransactionSystemId

public TransactionSystemId getTransactionSystemId(java.lang.String inHostIP,
                                                  int inHostPort,
                                                  java.lang.String inTransactionId)
                                           throws javax.resource.ResourceException
Get a text string containing the name of the CICS System Id (outSystemId) in which a given transaction Id (inTransactionId) executes. Returns outSystemId of all spaces if the transaction Id specified runs locally in the inHostIP inHostPort region.

Parameters:
inHostIP - - Text format IP address of the target host CICS region (for example, '234.164.88.1').
inHostPort - - Port corresponding to the target CICS region.
inTransactionId - - Text format Transaction Id (1 to 4 characters).
Returns:
TransactionSystemId
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

setTraceActive

public int setTraceActive(java.lang.String inTraceQueueName)
                   throws javax.resource.ResourceException
Start CICS 3270 Bridge Vector trace and optionally pass in a trace Temporary Storage queue name.

Parameters:
inTraceQueueName - - Optional Trace Name to use. If no name is given trace is activated using the name specified in previous setTraceActive or setTraceName method.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
javax.resource.ResourceException

setTraceInactive

public int setTraceInactive()
                     throws javax.resource.ResourceException
Stop CICS 3270 Bridge Vector trace.

Throws:
javax.resource.ResourceException

setTraceName

public int setTraceName(java.lang.String inTraceQueueName)
                 throws javax.resource.ResourceException
Set name of CICS 3270 Bridge Vector trace for this session.

Parameters:
inTraceQueueName - - Trace Name to use in subsequent trace operations.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
javax.resource.ResourceException

sendKeysGetString

public GetString sendKeysGetString(java.lang.String inKeys,
                                   int inStartRow,
                                   int inStartColumn,
                                   int inLength)
                            throws javax.resource.ResourceException
Sends a sequence of keystrokes and aid keys to the host and retrieves any text on the current screen at the specified row, column, and length. If the length parameter is zero, getString retrieves text from the specified row and column to the end of the screen. The Row and Column parameters must always be greater than or equal to 1. The sendKeysGetString method returns the correct value even though it is contained in non-display fields. Therefore, be sure to check the field attribute prior to displaying text retrieved with this method.

Parameters:
inKeys - - The HLLAPI style string of keys to send before collecting the requested string.
inStartRow - - The row position on the host screen at which to begin retrieving text.
inStartColumn - - The column position on the host screen at which to begin retrieving text.
inLength - - The length of the text string to be retrieved. If this value is zero, the text is retrieved up to the end of the screen.
Returns:
GetString
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

sendKeysGetAllFieldInformation

public AllFieldInformation sendKeysGetAllFieldInformation(java.lang.String inKeys)
                                                   throws javax.resource.ResourceException
Retrieves the information of all fields on the current screen.

Parameters:
inKeys - - The HLLAPI style string of keys to send before collecting the requested string.
Returns:
AllFieldInformation
Throws:
java.rmi.RemoteException
javax.resource.ResourceException

sendKeys

public int sendKeys(java.lang.String inKeys)
             throws javax.resource.ResourceException
Writes text to the session presentation space beginning at the current cursor position. If a protected field is encountered while writing, characters from the text string are discarded, and writing continues with the next unprotected field. If the HLLAPI representation of an AID keystroke is encountered in the text string, sendKeys initiates transmission to the host of the Aid key followed by any modified fields in the session presentation space. Text and AID keystrokes can be combined multiple times in the input string in this implementation.

Parameters:
inKeys - - The keys to send to the host. The HLLAPI representations for special keys that can be used follows:
 AID key : Key Sequence
 "@A@F"  :  Erase Input
 "@B"    :  Backtab 
 "@C"    :  Clear   
 "@E"    :  Enter   
 "@F"    :  Erase EOF
 "@L"    :  Cursor left
 "@N"    :  Newline
 "@T"    :  Tab     
 "@U"    :  Cursor up
 "@V"    :  Cursor down
 "@Z"    :  Cursor right
 "@<"    :  Backspace
 "@0"    :  Home  
 "@1"    :  PF1   
 "@2"    :  PF2   
 "@3"    :  PF3   
 "@4"    :  PF4   
 "@5"    :  PF5   
 "@6"    :  PF6   
 "@7"    :  PF7   
 "@8"    :  PF8   
 "@9"    :  PF9   
 "@a"    :  PF10  
 "@b"    :  PF11  
 "@c"    :  PF12  
 "@d"    :  PF13  
 "@e"    :  PF14  
 "@f"    :  PF15  
 "@g"    :  PF16  
 "@h"    :  PF17  
 "@i"    :  PF18  
 "@j"    :  PF19  
 "@k"    :  PF20  
 "@l"    :  PF21  
 "@m"    :  PF22  
 "@n"    :  PF23    
 "@o"    :  PF24  
 "@x"    :  PA1   
 "@y"    :  PA2   
 "@z"    :  PA3   
 
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
javax.resource.ResourceException

sendKeysEx

public int sendKeysEx(java.lang.String inKeys)
               throws javax.resource.ResourceException
This method is included for backward compatibility only. It is implemented as a sendKeys method call.

Parameters:
inKeys - - The keys to send to the host. The HLLAPI representations for special keys are documented under 'sendKeys':
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
javax.resource.ResourceException

setCursorPosition

public int setCursorPosition(int inRow,
                             int inColumn)
                      throws javax.resource.ResourceException
Sets the cursor position on the current host screen.

Parameters:
inRow - - The cursor row position. The first row is row 1.
inColumn - - The cursor column position. The first column is column 1.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
javax.resource.ResourceException

setFieldValue

public int setFieldValue(java.lang.String inField,
                         java.lang.String inValue)
                  throws javax.resource.ResourceException
Sets the value of the specified unprotected field on the current screen.

Parameters:
inField - - The field for which a value is to be set. This only valid value for this release is a null String, or spaces.
inValue - - The value to set for the specified field.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
javax.resource.ResourceException

setFieldValue

public int setFieldValue(int inField,
                         java.lang.String inValue)
                  throws javax.resource.ResourceException
Sets the value of the specified unprotected field on the current screen.

Parameters:
inField - - The field for which a value is to be set. This only valid value for this release is -1.
inValue - - The value to set for the specified field.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
javax.resource.ResourceException

setFieldValue

public int setFieldValue(java.lang.String[] inFields,
                         java.lang.String[] inValues)
                  throws javax.resource.ResourceException
Sets the value of an array of specified unprotected fields on the current screen with a single call. Use of this function will increase performance of applications when updating multiple fields.

Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
javax.resource.ResourceException

setSettleTime

public int setSettleTime(int inSettleTime)
                  throws javax.resource.ResourceException
This method is included for backward compatibility only. Performs no logic (NOP). There is no settle time requirement with the host data engine.

Parameters:
inSettleTime - - The amount of time (in milliseconds) the host waits after XCLOCK resets. The default is 500 milliseconds.
Returns:
zero for Success.
Throws:
javax.resource.ResourceException

setTimeOut

public int setTimeOut(int inTimeOut)
               throws javax.resource.ResourceException
This method is included for backward compatibility only. Performs no logic (NOP).

Parameters:
inTimeOut - - The number of milliseconds the host waits before timing out. The default is 20,000 milliseconds.
Returns:
zero for Success.
Throws:
javax.resource.ResourceException

terminate

public int terminate()
              throws javax.resource.ResourceException
This method is included for backward compatibility only. Performs no logic (NOP).

Returns:
zero for Success.
Throws:
javax.resource.ResourceException

Services Builder for CICS(R) 3270 Bridge v2.0.0.0