com.ibm.cics.server
Class TDQ

java.lang.Object
  extended bycom.ibm.cics.server.API
      extended bycom.ibm.cics.server.Resource
          extended bycom.ibm.cics.server.RemotableResource
              extended bycom.ibm.cics.server.TDQ
All Implemented Interfaces:
java.io.Serializable

public class TDQ
extends RemotableResource
implements java.io.Serializable

This Class provides the Java implementation of CICS Transient Data Queues (TDQs).

See Also:
Serialized Form

Constructor Summary
TDQ()
          Construct a TDQ bean.
 
Method Summary
 void delete()
          Delete a Transient Data Queue.
 void readData(DataHolder holder)
          Read data from a TDQ.
 void readDataConditional(DataHolder holder)
          Read data from a TDQ.
 void writeData(byte[] data)
          Write data to a TDQ.
 
Methods inherited from class com.ibm.cics.server.RemotableResource
getSysId, setSysId
 
Methods inherited from class com.ibm.cics.server.Resource
getDescription, getName, setDescription, setName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TDQ

public TDQ()
Construct a TDQ bean.

Method Detail

delete

public void delete()
            throws IOErrorException,
                   ISCInvalidRequestException,
                   NotAuthorisedException,
                   InvalidQueueIdException,
                   InvalidSystemIdException
Delete a Transient Data Queue.

Throws:
IOErrorException - An IOERR occurred.
ISCInvalidRequestException - An ISCINVREQ occurred.
NotAuthorisedException - A NOTAUTH occurred.
InvalidQueueIdException - A QIDERR occurred.
InvalidSystemIdException - A SYSIDERR occurred.

readData

public void readData(DataHolder holder)
              throws IOErrorException,
                     ISCInvalidRequestException,
                     LengthErrorException,
                     NotAuthorisedException,
                     NotOpenException,
                     InvalidQueueIdException,
                     QueueZeroException,
                     InvalidSystemIdException
Read data from a TDQ. If the queue is already being used for output, the task will be suspended.

Parameters:
holder - The holder for the data to be returned.
Throws:
IOErrorException - An IOERR occurred.
ISCInvalidRequestException - An ISCINVREQ occurred.
LengthErrorException - A LENGERR occurred.
NotAuthorisedException - A NOTAUTH occurred.
NotOpenException - A NOTOPEN occurred.
InvalidQueueIdException - A QIDERR occurred.
QueueZeroException - A QZERO occurred.
InvalidSystemIdException - A SYSIDERR occurred.

readDataConditional

public void readDataConditional(DataHolder holder)
                         throws IOErrorException,
                                ISCInvalidRequestException,
                                LengthErrorException,
                                NotAuthorisedException,
                                NotOpenException,
                                QueueBusyException,
                                InvalidQueueIdException,
                                QueueZeroException,
                                InvalidSystemIdException
Read data from a TDQ. If the queue is already being used for output, a QueueBusyException will be thrown.

Parameters:
holder - The holder for the data to be returned.
Throws:
IOErrorException - An IOERR occurred.
ISCInvalidRequestException - An ISCINVREQ occurred.
LengthErrorException - A LENGERR occurred.
NotAuthorisedException - A NOTAUTH occurred.
NotOpenException - A NOTOPEN occurred.
QueueBusyException - A QBUSY occurred.
InvalidQueueIdException - A QIDERR occurred.
QueueZeroException - A QZERO occurred.
InvalidSystemIdException - A SYSIDERR occurred.

writeData

public void writeData(byte[] data)
               throws IOErrorException,
                      ISCInvalidRequestException,
                      LengthErrorException,
                      NoSpaceException,
                      NotAuthorisedException,
                      NotOpenException,
                      InvalidSystemIdException
Write data to a TDQ.

Parameters:
data - A Java byte array containing the data to be written to the TDQ.
Throws:
IOErrorException - An IOERR occurred.
ISCInvalidRequestException - An ISCINVREQ occurred.
LengthErrorException - A LENGERR occurred.
NoSpaceException - A NOSPACE occurred.
NotAuthorisedException - A NOTAUTH occurred.
NotOpenException - A NOTOPEN occurred.
InvalidSystemIdException - A SYSIDERR occurred.