com.ibm.connector2.cics
Class ECIInteractionSpec

java.lang.Object
  extended bycom.ibm.connector2.cics.ECIInteractionSpec

public final class ECIInteractionSpec
extends java.lang.Object

An ECIInteractionSpec is used to define the details of an interaction with CICS.


Field Summary
static java.lang.String CLASS_VERSION
           
 
Constructor Summary
ECIInteractionSpec()
          Default Constructor.
ECIInteractionSpec(int verb, java.lang.String prog)
          Simple constructor.
ECIInteractionSpec(int verb, java.lang.String prog, int timeout, int commLen, int repLen)
          Complete constructor allows specification of all properties.
 
Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Add a listener to those that are informed when a bound property is changed.
 int getCommareaLength()
          Accessor for commareaLength.
 int getExecuteTimeout()
          Accessor for executeTimeout.
 java.lang.String getFunctionName()
          Accessor for FunctionName.
 int getInteractionVerb()
          Accessor for InteractionVerb.
 int getReplyLength()
          Accessor for replyLength.
 java.lang.String getTPNName()
          Allows access to the TPN mirror transaction Name that all CICS request will run under.
 java.lang.String getTranName()
          Allows access to the mirror transaction Name that all CICS requests will run under.
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Remove a registered listener from the list.
 void setCommareaLength(int length)
          Sets the Commarea Length.
 void setExecuteTimeout(int time)
          Sets the Execute Time-out.
 void setFunctionName(java.lang.String name)
          Sets the Function Name.
 void setInteractionVerb(int verb)
          Sets the Interaction Verb.
 void setReplyLength(int length)
          Sets the Reply Length.
 void setTPNName(java.lang.String name)
          Sets the TPN Transaction Name that all CICS requests will run under.
 void setTranName(java.lang.String name)
          Sets the Transaction Name that all CICS requests will run under.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION
See Also:
Constant Field Values
Constructor Detail

ECIInteractionSpec

public ECIInteractionSpec(int verb,
                          java.lang.String prog,
                          int timeout,
                          int commLen,
                          int repLen)
                   throws ResourceException
Complete constructor allows specification of all properties.

Parameters:
verb - The InteractionVerb to use
prog - The name of the CICS Program to call
timeout - The interaction timeout value in seconds
commLen - The length of the COMMAREA being passed to CICS
repLen - The length of reply wanted from CICS

ECIInteractionSpec

public ECIInteractionSpec(int verb,
                          java.lang.String prog)
                   throws ResourceException
Simple constructor. Allows definition of program name and interaction verb. The timeout defaults to none and the commarealength and replyLength are not used.

Parameters:
verb - The InteractionVerb to use
prog - The name of the CICS Program to call

ECIInteractionSpec

public ECIInteractionSpec()
Default Constructor.

Method Detail

toString

public java.lang.String toString()

getInteractionVerb

public int getInteractionVerb()
Accessor for InteractionVerb.

Returns:
The current InteractionVerb i.e. SYNC_SEND

getFunctionName

public java.lang.String getFunctionName()
Accessor for FunctionName.

Returns:
The current program name to run

getExecuteTimeout

public int getExecuteTimeout()
Accessor for executeTimeout.

Returns:
The current timeout value

getCommareaLength

public int getCommareaLength()
Accessor for commareaLength.

Returns:
The current commareaLength

getReplyLength

public int getReplyLength()
Accessor for replyLength.

Returns:
The current replyLength

getTranName

public java.lang.String getTranName()
Allows access to the mirror transaction Name that all CICS requests will run under.

Returns:
The current Transid to run under

getTPNName

public java.lang.String getTPNName()
Allows access to the TPN mirror transaction Name that all CICS request will run under.

Returns:
The current TPN id to run under

setInteractionVerb

public void setInteractionVerb(int verb)
                        throws ResourceException
Sets the Interaction Verb.

Parameters:
verb - The new Interaction Verb to use.
Throws:
ResourceException

setFunctionName

public void setFunctionName(java.lang.String name)
Sets the Function Name.

Parameters:
name - The new program name to run.

setExecuteTimeout

public void setExecuteTimeout(int time)
                       throws ResourceException
Sets the Execute Time-out.

Parameters:
time - The new Execute Time-out value.
Throws:
ResourceException

setCommareaLength

public void setCommareaLength(int length)
Sets the Commarea Length.

Parameters:
length - The new Commarea Length value.

setReplyLength

public void setReplyLength(int length)
Sets the Reply Length.

Parameters:
length - The new Reply Length value.

setTranName

public void setTranName(java.lang.String name)
Sets the Transaction Name that all CICS requests will run under.

Parameters:
name - The new Transid to use.

setTPNName

public void setTPNName(java.lang.String name)

Sets the TPN Transaction Name that all CICS requests will run under.

Note: This takes precedence over TranName so if both are specified TPNName will be used.

Parameters:
name - The new Transid to use.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Add a listener to those that are informed when a bound property is changed.


removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Remove a registered listener from the list.