|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.ibm.cics.server.API
com.ibm.cics.server.Resource
com.ibm.cics.server.RemotableResource
com.ibm.cics.server.TSQ
public class TSQ
This Class provides the Java interface to CICS Temporary Storage Queues (TSQs).
| Constructor Summary | |
|---|---|
TSQ()
Construct a TSQ bean. |
|
| Method Summary | |
|---|---|
void |
delete()
Delete a Temporary Storage Queue (TSQ). |
java.lang.String |
getName()
Return the name of the TSQ as a string, using the platform's default character encoding to convert from the internal byte[] format in which the name is stored. |
byte[] |
getQueueName()
Return the queueName of the TSQ. |
TSQType |
getType()
Return the type of the TSQ. |
int |
readItem(int item,
ItemHolder holder)
Read a specified item from a TSQ. |
int |
readNextItem(ItemHolder holder)
Read the next item from a TSQ. |
void |
rewriteItem(int item,
byte[] data)
Rewrite an existing item. |
void |
rewriteItemConditional(int item,
byte[] data)
Rewrite an existing item. |
void |
setName(java.lang.String name)
Sets the name of the TSQ. |
void |
setQueueName(byte[] queueName)
Sets the queueName of the TSQ. |
void |
setType(TSQType type)
Sets the type of the TSQ. |
int |
writeItem(byte[] data)
Simplest version of WRITEQ TS. |
int |
writeItemConditional(byte[] data)
Write an item to a TSQ. |
| Methods inherited from class com.ibm.cics.server.RemotableResource |
|---|
getSysId, setSysId |
| Methods inherited from class com.ibm.cics.server.Resource |
|---|
getDescription, setDescription |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public TSQ()
| Method Detail |
|---|
public void delete()
throws InvalidRequestException,
IOErrorException,
ISCInvalidRequestException,
NotAuthorisedException,
InvalidQueueIdException,
InvalidSystemIdException
InvalidRequestException - An INVREQ occurred.
IOErrorException - An IOERR occurred.
ISCInvalidRequestException - An ISCINVREQ occurred.
NotAuthorisedException - A NOTAUTH occurred.
InvalidQueueIdException - A QIDERR occurred.
InvalidSystemIdException - A SYSIDERR occurred.public java.lang.String getName()
getName in class Resourcepublic byte[] getQueueName()
public TSQType getType()
public int readItem(int item,
ItemHolder holder)
throws InvalidRequestException,
IOErrorException,
ISCInvalidRequestException,
ItemErrorException,
LengthErrorException,
NotAuthorisedException,
InvalidQueueIdException,
InvalidSystemIdException
item - The number of the item to read.holder - The holder for the data to be returned.
InvalidRequestException - An INVREQ occurred.
IOErrorException - An IOERR occurred.
ISCInvalidRequestException - An ISCINVREQ occurred.
ItemErrorException - An ITEMERROR occurred.
LengthErrorException - A LENGERR occurred.
NotAuthorisedException - A NOTAUTH occurred.
InvalidQueueIdException - A QIDERR occurred.
InvalidSystemIdException - A SYSIDERR occurred.
public int readNextItem(ItemHolder holder)
throws InvalidRequestException,
IOErrorException,
ISCInvalidRequestException,
ItemErrorException,
LengthErrorException,
NotAuthorisedException,
InvalidQueueIdException,
InvalidSystemIdException
holder - The holder for the data to be returned.
InvalidRequestException - An INVREQ occurred.
IOErrorException - An IOERR occurred.
ISCInvalidRequestException - An ISCINVREQ occurred.
ItemErrorException - An ITEMERROR occurred.
LengthErrorException - A LENGERR occurred.
NotAuthorisedException - A NOTAUTH occurred.
InvalidQueueIdException - A QIDERR occurred.
InvalidSystemIdException - A SYSIDERR occurred.
public void rewriteItem(int item,
byte[] data)
throws InvalidRequestException,
IOErrorException,
ISCInvalidRequestException,
ItemErrorException,
LengthErrorException,
NotAuthorisedException,
InvalidQueueIdException,
InvalidSystemIdException
item - The number of the item to be rewritten.data - A Java byte array containing the data to rewrite.
InvalidRequestException - An INVREQ occurred.
IOErrorException - An IOERR occurred.
ISCInvalidRequestException - An ISCINVREQ occurred.
ItemErrorException - An ITEMERROR occurred.
LengthErrorException - A LENGERR occurred.
NotAuthorisedException - A NOTAUTH occurred.
InvalidQueueIdException - A QIDERR occurred.
InvalidSystemIdException - A SYSIDERR occurred.
public void rewriteItemConditional(int item,
byte[] data)
throws InvalidRequestException,
IOErrorException,
ISCInvalidRequestException,
ItemErrorException,
LengthErrorException,
NoSpaceException,
NotAuthorisedException,
InvalidQueueIdException,
InvalidSystemIdException
item - The number of the item to be rewritten.data - A Java byte array containing the data to rewrite.
InvalidRequestException - An INVREQ occurred.
IOErrorException - An IOERR occurred.
ISCInvalidRequestException - An ISCINVREQ occurred.
ItemErrorException - An ITEMERROR occurred.
LengthErrorException - A LENGERR occurred.
NoSpaceException - A NOSPACE occurred.
NotAuthorisedException - A NOTAUTH occurred.
InvalidQueueIdException - A QIDERR occurred.
InvalidSystemIdException - A SYSIDERR occurred.
public void setName(java.lang.String name)
throws java.lang.NullPointerException
setName in class Resourcename - the name of the TSQ as a string.
This string is padded with blanks and converted to bytes using the
platform's default character encoding. Over-length queue names will
be truncated.
java.lang.NullPointerException - queueName is null
public void setQueueName(byte[] queueName)
throws java.lang.NullPointerException
queueName - the queueName of the TSQ.
If the queueName passed in is shorter than 16 bytes it is padded to
the correct length with spaces. Over-length queueNames will be truncated.
java.lang.NullPointerException - queueName is nullpublic void setType(TSQType type)
type - the type of the TSQ.
public int writeItem(byte[] data)
throws InvalidRequestException,
IOErrorException,
ISCInvalidRequestException,
ItemErrorException,
LengthErrorException,
NotAuthorisedException,
InvalidSystemIdException
WRITEQ TS.
If there is insufficient space in the TS data-set, the task will
be suspended.
data - A Java byte array containing the data to be written to the
TSQ.
InvalidRequestException - An INVREQ occurred.
IOErrorException - An IOERR occurred.
ISCInvalidRequestException - An ISCINVREQ occurred.
ItemErrorException - An ITEMERROR occurred.
LengthErrorException - A LENGERR occurred.
NotAuthorisedException - A NOTAUTH occurred.
InvalidSystemIdException - A SYSIDERR occurred.
public int writeItemConditional(byte[] data)
throws InvalidRequestException,
IOErrorException,
ISCInvalidRequestException,
ItemErrorException,
LengthErrorException,
NoSpaceException,
NotAuthorisedException,
InvalidSystemIdException
data - A Java byte array containing the data to rewrite.
InvalidRequestException - An INVREQ occurred.
IOErrorException - An IOERR occurred.
ISCInvalidRequestException - An ISCINVREQ occurred.
ItemErrorException - An ITEMERROR occurred.
LengthErrorException - A LENGERR occurred.
NoSpaceException - A NOSPACE occurred.
NotAuthorisedException - A NOTAUTH occurred.
InvalidSystemIdException - A SYSIDERR occurred.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||