Package All Classes All Fields and Methods Deprecated


com.ibm.connector2.ims.ico
Interface IMSInteractionSpecProperties

All Known Implementing Classes:
IMSInteractionSpec

public interface IMSInteractionSpecProperties

This interface defines named constants used by an IMSInteractionSpec object.


Field Summary
static java.lang.String copyright
           
static boolean DEFAULT_ASYNCOUTPUT_AVAILABLE
          IMS Connector for Java internal use only.
static int DEFAULT_CONVERTED_TIMEOUT_VALUE
          IMS Connector for Java internal use only.
static int DEFAULT_INTERACTION_VERB
          IMS Connector for Java internal use only.
static boolean DEFAULT_PURGE_ASYNCOUTPUT
          IMS Connector for Java internal use only.
static boolean DEFAULT_REROUTE
          IMS Connector for Java internal use only.
static int DEFAULT_RUNTIME_IMS_REQUEST_TYPE
          IMS Connector for Java internal use only.
static int DEFAULT_SOTIMEOUT_VALUE
          IMS Connector for Java internal use only.
static int DEFAULT_TIMEOUT_INDEX_VALUE
          IMS Connector for Java internal use only.
static int DEFAULT_TIMEOUT_VALUE
          IMS Connector for Java internal use only.
static int IMS_REQUEST_TYPE_IMS_COMMAND
          The request is an IMS command.
static int IMS_REQUEST_TYPE_IMS_TRANSACTION
          The request is an IMS transaction.
static int IMS_REQUEST_TYPE_MFS_TRANSACTION
          Reserved for applications that are generated using WebSphere Studio MFS support.
static int MAX_TIMEOUT_VALUE
          IMS Connector for Java internal use only.
static int NUM_OF_BASE_VERBS
          IMS Connector for Java internal use only.
static int NUM_OF_IMS_VERBS
          IMS Connector for Java internal use only.
static int NUM_OF_VERBS
          IMS Connector for Java internal use only.
static int SYNC_END_CONVERSATION
          Used for the interactionVerb property of an IMSInteractionSpec instance to force the end of an IMS conversation.
static int SYNC_LEVEL
          IMSInteractionSpec property to set the IMS Synchronous Level.
static java.lang.String SYNC_LEVEL_TEXT
          IMS Connector for Java internal use only.
static int SYNC_RECEIVE_ASYNCOUTPUT
          Used for the interactionVerb property of an IMSInteractionSpec instance to retrieve asynchronous output messages.
static int SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_NOWAIT
          Used for the interactionVerb property of an IMSInteractionSpec instance to retrieve asynchronous output messages.
static int SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT
          Used for the interactionVerb property of an IMSInteractionSpec instance to retrieve asynchronous output messages.
static int TIMEOUT_DEFAULT
          IMS Connector for Java internal use only.
static int TIMEOUT_NOWAIT_FLAG
          IMS Connector for Java internal use only.
static int TIMEOUT_SMALL
          IMS Connector for Java internal use only.
static int TIMEOUT_WAITFOREVER_FLAG
          IMS Connector for Java internal use only.
static java.lang.String VERB_SYNC_END_CONVERSATION_TEXT
          IMS Connector for Java internal use only.
static java.lang.String VERB_SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_NOWAIT_TEXT
          IMS Connector for Java internal use only.
static java.lang.String VERB_SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT_TEXT
          IMS Connector for Java internal use only.
static java.lang.String VERB_SYNC_RECEIVE_ASYNCOUTPUT_TEXT
          IMS Connector for Java internal use only.
static java.lang.String VERB_SYNC_RECEIVE_TEXT
          IMS Connector for Java internal use only.
static java.lang.String VERB_SYNC_SEND_RECEIVE_TEXT
          IMS Connector for Java internal use only.
static java.lang.String VERB_SYNC_SEND_TEXT
          IMS Connector for Java internal use only.
 

Field Detail

copyright

public static final java.lang.String copyright
See Also:
Constant Field Values

DEFAULT_INTERACTION_VERB

public static final int DEFAULT_INTERACTION_VERB
IMS Connector for Java internal use only.

See Also:
Constant Field Values

DEFAULT_ASYNCOUTPUT_AVAILABLE

public static final boolean DEFAULT_ASYNCOUTPUT_AVAILABLE
IMS Connector for Java internal use only.

See Also:
Constant Field Values

DEFAULT_PURGE_ASYNCOUTPUT

public static final boolean DEFAULT_PURGE_ASYNCOUTPUT
IMS Connector for Java internal use only.

See Also:
Constant Field Values

DEFAULT_REROUTE

public static final boolean DEFAULT_REROUTE
IMS Connector for Java internal use only.

See Also:
Constant Field Values

SYNC_END_CONVERSATION

public static final int SYNC_END_CONVERSATION
Used for the interactionVerb property of an IMSInteractionSpec instance to force the end of an IMS conversation.

See Also:
Constant Field Values

SYNC_LEVEL

public static final int SYNC_LEVEL
IMSInteractionSpec property to set the IMS Synchronous Level. Valid values are NONE (0) and CONFIRM (1).

See Also:
Constant Field Values

SYNC_RECEIVE_ASYNCOUTPUT

public static final int SYNC_RECEIVE_ASYNCOUTPUT
Used for the interactionVerb property of an IMSInteractionSpec instance to retrieve asynchronous output messages. With this type of interaction the Java client can only receive a single message. If there are no messages in the IMS OTMA Asynchronous Queue for the clientID when the request is made, no further attempts will be made to retrieve the message. No message will be returned and a timeout will occur after the length of time specified in the executionTimeout property of the SYNC_RECEIVE_ASYNCOUTPUT interaction.

See Also:
Constant Field Values

SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_NOWAIT

public static final int SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_NOWAIT
Used for the interactionVerb property of an IMSInteractionSpec instance to retrieve asynchronous output messages. With this type of interaction the Java client can only receive a single message. If there are no messages in the IMS OTMA Asynchronous Queue for the clientID when the request is made, no further attempts will be made to retrieve the message. No message will be returned and an exception will immediately be returned in response to the SYNC_RECEIVE_ASYNCOUTPUT_NOWAITinteraction. The executionTimeout property of IMSInteractionSpec will be ignored if SYNC_RECEIVE_ASYNCOUTPUT_NOWAIT is specified. SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_NOWAIT interactions are supported on shareable and dedicated persistent socket connections.

See Also:
Constant Field Values

SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT

public static final int SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT
Used for the interactionVerb property of an IMSInteractionSpec instance to retrieve asynchronous output messages. With this type of interaction the Java client can only receive a single message. If there are no messages in the IMS OTMA Asynchronous Queue for the clientID when the request is made, IMS Connect will wait for OTMA to return a message IMS Connect will wait the length of time specified in the executionTimeout property of the SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT interaction before returning an exception. SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT interactions are supported on shareable and dedicated persistent socket connections.

See Also:
Constant Field Values

NUM_OF_BASE_VERBS

public static final int NUM_OF_BASE_VERBS
IMS Connector for Java internal use only.

See Also:
Constant Field Values

NUM_OF_IMS_VERBS

public static final int NUM_OF_IMS_VERBS
IMS Connector for Java internal use only.

See Also:
Constant Field Values

NUM_OF_VERBS

public static final int NUM_OF_VERBS
IMS Connector for Java internal use only.

See Also:
Constant Field Values

VERB_SYNC_SEND_RECEIVE_TEXT

public static final java.lang.String VERB_SYNC_SEND_RECEIVE_TEXT
IMS Connector for Java internal use only.

See Also:
Constant Field Values

VERB_SYNC_SEND_TEXT

public static final java.lang.String VERB_SYNC_SEND_TEXT
IMS Connector for Java internal use only.

See Also:
Constant Field Values

VERB_SYNC_RECEIVE_TEXT

public static final java.lang.String VERB_SYNC_RECEIVE_TEXT
IMS Connector for Java internal use only.

See Also:
Constant Field Values

VERB_SYNC_END_CONVERSATION_TEXT

public static final java.lang.String VERB_SYNC_END_CONVERSATION_TEXT
IMS Connector for Java internal use only.

See Also:
Constant Field Values

VERB_SYNC_RECEIVE_ASYNCOUTPUT_TEXT

public static final java.lang.String VERB_SYNC_RECEIVE_ASYNCOUTPUT_TEXT
IMS Connector for Java internal use only.

See Also:
Constant Field Values

VERB_SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_NOWAIT_TEXT

public static final java.lang.String VERB_SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_NOWAIT_TEXT
IMS Connector for Java internal use only.

See Also:
Constant Field Values

VERB_SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT_TEXT

public static final java.lang.String VERB_SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT_TEXT
IMS Connector for Java internal use only.

See Also:
Constant Field Values

SYNC_LEVEL_TEXT

public static final java.lang.String SYNC_LEVEL_TEXT
IMS Connector for Java internal use only.

See Also:
Constant Field Values

IMS_REQUEST_TYPE_IMS_TRANSACTION

public static final int IMS_REQUEST_TYPE_IMS_TRANSACTION
The request is an IMS transaction. Normal transaction output returned by IMS is used to populate the application's output message. If IMS returns a "DFS" message, the IMS resource adapter throws an IMSDFSMessageException.

This value for imsRequestType is used for applications that are not generated using WebSphere Studio MFS support.

See Also:
Constant Field Values

IMS_REQUEST_TYPE_IMS_COMMAND

public static final int IMS_REQUEST_TYPE_IMS_COMMAND
The request is an IMS command. Command output returned by IMS, including "DFS" messages, are used to populate the application's output message. The IMSDFSMessageException is not thrown.

This value for imsRequestType is used for applications that submit IMS commands.

See Also:
Constant Field Values

IMS_REQUEST_TYPE_MFS_TRANSACTION

public static final int IMS_REQUEST_TYPE_MFS_TRANSACTION
Reserved for applications that are generated using WebSphere Studio MFS support. Normal transaction output returned by IMS, as well as "DFS" messages, are used to populate the application's output message. The IMSDFSMessageException is not thrown.

See Also:
Constant Field Values

DEFAULT_RUNTIME_IMS_REQUEST_TYPE

public static final int DEFAULT_RUNTIME_IMS_REQUEST_TYPE
IMS Connector for Java internal use only.

See Also:
Constant Field Values

DEFAULT_TIMEOUT_VALUE

public static final int DEFAULT_TIMEOUT_VALUE
IMS Connector for Java internal use only.

See Also:
Constant Field Values

DEFAULT_CONVERTED_TIMEOUT_VALUE

public static final int DEFAULT_CONVERTED_TIMEOUT_VALUE
IMS Connector for Java internal use only.

See Also:
Constant Field Values

MAX_TIMEOUT_VALUE

public static final int MAX_TIMEOUT_VALUE
IMS Connector for Java internal use only.

See Also:
Constant Field Values

TIMEOUT_WAITFOREVER_FLAG

public static final int TIMEOUT_WAITFOREVER_FLAG
IMS Connector for Java internal use only.

See Also:
Constant Field Values

TIMEOUT_NOWAIT_FLAG

public static final int TIMEOUT_NOWAIT_FLAG
IMS Connector for Java internal use only.

See Also:
Constant Field Values

TIMEOUT_DEFAULT

public static final int TIMEOUT_DEFAULT
IMS Connector for Java internal use only.

See Also:
Constant Field Values

TIMEOUT_SMALL

public static final int TIMEOUT_SMALL
IMS Connector for Java internal use only.

See Also:
Constant Field Values

DEFAULT_TIMEOUT_INDEX_VALUE

public static final int DEFAULT_TIMEOUT_INDEX_VALUE
IMS Connector for Java internal use only.

See Also:
Constant Field Values

DEFAULT_SOTIMEOUT_VALUE

public static final int DEFAULT_SOTIMEOUT_VALUE
IMS Connector for Java internal use only.

See Also:
Constant Field Values

Package All Classes All Fields and Methods Deprecated