com.ibm.dse.services.cics
Interface CICSConnectionService

All Known Implementing Classes:
CICSConnection

public interface CICSConnectionService
extends CommonCommunicationsService

Interface for CICS connector.


Fields inherited from interface com.ibm.dse.services.comms.CommonCommunicationsService
CLOSED, DATA, DATASENT, ERROR, OPENED, RECEIVERC, TIMEOUT
 
Method Summary
 void closeConnection()
          Closes the CICS connection.
 void establishConnection()
          Establishes a CICS connection.
 java.lang.String getGatewayName()
          Returns the value of the gatewayName attribute.
 int getGatewayPort()
          Returns the value of the gatewayPort attribute.
 java.lang.String getProgramName()
          Returns the value of the programName attribute.
 java.lang.String getServerName()
          Returns the value of the serverName attribute.
 java.lang.String getStatus()
          Returns the value of the status attribute.
 java.lang.String getTransactionId()
          Returns the value of the transactionId attribute.
 java.lang.String getUserId()
          Returns the value of the userId attribute.
 void setGatewayName(java.lang.String aName)
          Sets the value of the gatewayName property.
 void setGatewayPort(int aPort)
          Sets the value of the gatewayPort property.
 void setPassword(java.lang.String aPassword)
          Sets the value of the password property.
 void setProgramName(java.lang.String aProgram)
          Sets the value of the programName property.
 void setServerName(java.lang.String aName)
          Sets the value of the serverName property.
 void setTransactionId(java.lang.String aId)
          Sets the value of the transactionId property.
 void setUserId(java.lang.String aUser)
          Sets the value of the userId property.
 void terminate()
          Terminates the CICS connection.
 
Methods inherited from interface com.ibm.dse.services.comms.CommonCommunicationsService
ccClose, ccOpen, ccReceiveData, ccSendData, ccSendReceive, getCcClosedEventName, getCcDataReceivedEventName, getCcErrorReceivedEventName, getCcOpenedEventName, isFree, isOffline, setInUse
 
Methods inherited from interface com.ibm.dse.base.Notifier
addHandler, getHandlersList, getName, removeHandler, setName, signalEvent, signalEvent
 

Method Detail

closeConnection

public void closeConnection()
                     throws java.lang.Exception
Closes the CICS connection.
Throws:
Exception. -  

establishConnection

public void establishConnection()
                         throws java.lang.Exception
Establishes a CICS connection.
Throws:
Exception. -  

getGatewayName

public java.lang.String getGatewayName()
Returns the value of the gatewayName attribute.
Returns:
String - The current value of gatewayName.

getGatewayPort

public int getGatewayPort()
Returns the value of the gatewayPort attribute.
Returns:
int - The current value of gatewayPort.

getProgramName

public java.lang.String getProgramName()
Returns the value of the programName attribute.
Returns:
String - The current value of programName.

getServerName

public java.lang.String getServerName()
Returns the value of the serverName attribute.
Returns:
String - The current value of serverName.

getStatus

public java.lang.String getStatus()
Returns the value of the status attribute.
Returns:
String - The current value of status.

getTransactionId

public java.lang.String getTransactionId()
Returns the value of the transactionId attribute.
Returns:
String - The current value of transactionId.

getUserId

public java.lang.String getUserId()
Returns the value of the userId attribute.
Returns:
String - The current value of userId.

setGatewayName

public void setGatewayName(java.lang.String aName)
Sets the value of the gatewayName property.
Parameters:
aName - String The new value of the property.

setGatewayPort

public void setGatewayPort(int aPort)
Sets the value of the gatewayPort property.
Parameters:
aPort - int The new value of the property.

setPassword

public void setPassword(java.lang.String aPassword)
Sets the value of the password property.
Parameters:
aPassword - String The new value of the property.

setProgramName

public void setProgramName(java.lang.String aProgram)
Sets the value of the programName property.
Parameters:
aProgram - String The new value of the property.

setServerName

public void setServerName(java.lang.String aName)
Sets the value of the serverName property.
Parameters:
aName - String The new value of the property.

setTransactionId

public void setTransactionId(java.lang.String aId)
Sets the value of the transactionId property.
Parameters:
aId - String The new value of the property.

setUserId

public void setUserId(java.lang.String aUser)
Sets the value of the userId property.
Parameters:
aUser - String The new value of the property.

terminate

public void terminate()
Terminates the CICS connection.