com.ibm.cics.server
Class AttachInitiator

java.lang.Object
  |
  +--com.ibm.cics.server.API
        |
        +--com.ibm.cics.server.AttachInitiator
All Implemented Interfaces:
java.io.Serializable

public class AttachInitiator
extends API
implements java.io.Serializable

This bean is the main interface to APPC.

See Also:
Serialized Form

Constructor Summary
AttachInitiator()
           
 
Method Summary
 java.lang.String getProcess()
           
 java.lang.String getProfile()
           
 boolean getQueue()
           
 SyncLevel getSyncLevel()
           
 java.lang.String getSysId()
           
 Conversation initiate()
           
 Conversation initiate(byte[] pipdata)
           
 void setProcess(java.lang.String process)
          Sets the process of the attach.
 void setProfile(java.lang.String profile)
          Sets the profile of the attach.
 void setQueue(boolean queue)
           
 void setSyncLevel(SyncLevel syncLevel)
           
 void setSysId(java.lang.String sysId)
          Sets the SYSID of the remote region that this Attach is targetted at.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AttachInitiator

public AttachInitiator()
Method Detail

getProcess

public java.lang.String getProcess()

getProfile

public java.lang.String getProfile()

getQueue

public boolean getQueue()

getSyncLevel

public SyncLevel getSyncLevel()

getSysId

public java.lang.String getSysId()

initiate

public Conversation initiate()
                      throws InvalidSystemIdException,
                             InvalidRequestException,
                             LengthErrorException,
                             NotAuthorisedException,
                             NotAllocatedException,
                             SystemBusyException

initiate

public Conversation initiate(byte[] pipdata)
                      throws InvalidSystemIdException,
                             InvalidRequestException,
                             LengthErrorException,
                             NotAuthorisedException,
                             NotAllocatedException,
                             SystemBusyException

setProcess

public void setProcess(java.lang.String process)
                throws java.lang.NullPointerException
Sets the process of the attach.
Parameters:
process - the name of the process
Throws:
java.lang.NullPointerException - This exception is thrown if a null process name is supplied.

setProfile

public void setProfile(java.lang.String profile)
                throws java.lang.NullPointerException
Sets the profile of the attach.
Parameters:
profile - the name of the profile
Throws:
java.lang.NullPointerException - This exception is thrown if a null profile name is supplied.

setQueue

public void setQueue(boolean queue)

setSyncLevel

public void setSyncLevel(SyncLevel syncLevel)

setSysId

public void setSysId(java.lang.String sysId)
              throws java.lang.NullPointerException,
                     InvalidSystemIdException
Sets the SYSID of the remote region that this Attach is targetted at.
Parameters:
sysId - the name of the CICS system
Throws:
java.lang.NullPointerException - This exception is thrown if a null name is supplied.
InvalidSystemIdException - This exception is thrown if an empty SYSID is supplied.