com.ibm.cics.server
Class AttachInitiator

java.lang.Object
  extended by com.ibm.cics.server.API
      extended by 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
Since CICS TS version:
1.3
Since package version:
1.0

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 targeted 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()
Returns:
the process
Since CICS TS version:
1.3
Since package version:
1.0

getProfile

public java.lang.String getProfile()
Returns:
the profile
Since CICS TS version:
1.3
Since package version:
1.0

getQueue

public boolean getQueue()
Returns:
the queue
Since CICS TS version:
1.3
Since package version:
1.0

getSyncLevel

public SyncLevel getSyncLevel()
Returns:
the sync level
Since CICS TS version:
1.3
Since package version:
1.0

getSysId

public java.lang.String getSysId()
Returns:
the SYSID
Since CICS TS version:
1.3
Since package version:
1.0

initiate

public Conversation initiate()
                      throws InvalidSystemIdException,
                             InvalidRequestException,
                             LengthErrorException,
                             NotAuthorisedException,
                             NotAllocatedException,
                             SystemBusyException
Returns:
a Conversation object
Throws:
InvalidSystemIdException - SYSIDERR
InvalidRequestException - INVREQ
LengthErrorException - LENGERR
NotAuthorisedException - NOTAUTH
NotAllocatedException - NOTALLOC
SystemBusyException - SYSBUSY
Since CICS TS version:
1.3
Since package version:
1.0

initiate

public Conversation initiate(byte[] pipdata)
                      throws InvalidSystemIdException,
                             InvalidRequestException,
                             LengthErrorException,
                             NotAuthorisedException,
                             NotAllocatedException,
                             SystemBusyException
Parameters:
pipdata - data
Returns:
a Conversation object
Throws:
InvalidSystemIdException - SYSIDERR
InvalidRequestException - INVREQ
LengthErrorException - LENGERR
NotAuthorisedException - NOTAUTH
NotAllocatedException - NOTALLOC
SystemBusyException - SYSBUSY
Since CICS TS version:
1.3
Since package version:
1.0

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.
Since CICS TS version:
1.3
Since package version:
1.0

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.
Since CICS TS version:
1.3
Since package version:
1.0

setQueue

public void setQueue(boolean queue)
Parameters:
queue - the queue name
Since CICS TS version:
1.3
Since package version:
1.0

setSyncLevel

public void setSyncLevel(SyncLevel syncLevel)
Parameters:
syncLevel - the sync level
Since CICS TS version:
1.3
Since package version:
1.0

setSysId

public void setSysId(java.lang.String sysId)
              throws java.lang.NullPointerException,
                     InvalidSystemIdException
Sets the SYSID of the remote region that this Attach is targeted 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.
Since CICS TS version:
1.3
Since package version:
1.0