com.ibm.cics.model
Interface ITSQueue

All Superinterfaces:
ICICSObject, ICICSResource
All Known Subinterfaces:
IMutableTSQueue

public interface ITSQueue
extends ICICSResource

generated from CICS resourcetable TSQUEUE


Nested Class Summary
static class ITSQueue.LocationValue
          Enumeration type for field LOCATION
static class ITSQueue.RecovstatusValue
          Enumeration type for field RECOVSTATUS
 
Method Summary
 java.lang.Long getItemCount()
          Getter for field NUMITEMS
 java.lang.Long getLastusedint()
          Getter for field LASTUSEDINT
 ITSQueue.LocationValue getLocation()
          Getter for field LOCATION
 java.lang.Long getMaxItemLength()
          Getter for field MAXITEMLEN
 java.lang.Long getMinItemLength()
          Getter for field MINITEMLEN
 java.lang.String getName()
          Getter for field NAME
 java.lang.Long getQueueLength()
          Getter for field QUELENGTH
 ITSQueue.RecovstatusValue getRecovstatus()
          Getter for field RECOVSTATUS
 java.lang.String getTransid()
          Getter for field TRANSID
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 

Method Detail

getName

java.lang.String getName()
Getter for field NAME

Queue name

The name of the temporary storage queue.

Specified by:
getName in interface ICICSObject

getLocation

ITSQueue.LocationValue getLocation()
Getter for field LOCATION

Queue location

Identifies the location of the temporary storage queue as one of the following:


getQueueLength

java.lang.Long getQueueLength()
Getter for field QUELENGTH

Queue length (bytes)

The total length, in bytes, of all the items in the temporary storage queue.

If an AUXILIARY TSQ contains an item that is larger than the control interval size of the temporary storage data set, this field will be displayed as N/A.


getMaxItemLength

java.lang.Long getMaxItemLength()
Getter for field MAXITEMLEN

Largest queue item length (bytes)

The length in bytes of the largest item in the temporary storage queue.

The length of a queue item is the sum of the length of the user data plus 8 bytes for header information, rounded up. For main storage queues, the length is rounded up to the boundary of the MVS storage subpool used to store it.

For auxiliary temporary storage, the length is rounded to the next highest multiple of either 64 or 128 (depending on the control interval size of the temporary storage data set). (For background information about CI sizes, see The control interval size.)

For shared queues, the lengths returned in MINITEMLEN, MAXITEMLEN, and QUELENGTH, reflect the data length stored in the coupling facility. This includes any item control information, which consists of a 2-byte length prefix for each item.

For all types of queue the maximum value returned will be capped at 32767 (Hex '7FFF').


getMinItemLength

java.lang.Long getMinItemLength()
Getter for field MINITEMLEN

Smallest queue item length (bytes)

The length, in bytes, of the smallest item in the temporary storage queue.

If an AUXILIARY TSQ contains an item that is larger than the control interval size of the temporary storage data set, this field will be displayed as N/A.


getItemCount

java.lang.Long getItemCount()
Getter for field NUMITEMS

Number of items in queue

The number of items in the temporary storage queue.


getLastusedint

java.lang.Long getLastusedint()
Getter for field LASTUSEDINT

Interval since queue last used (seconds)

The interval, in seconds, since the temporary storage queue was last referenced.


getTransid

java.lang.String getTransid()
Getter for field TRANSID

Transaction that created TS queue

The ID of the transaction that created the temporary storage queue.


getRecovstatus

ITSQueue.RecovstatusValue getRecovstatus()
Getter for field RECOVSTATUS

Recovery status

The type of recovery attribute defined for the temporary storage queue.



Copyright © 2008-2009 IBM Corp. All Rights Reserved.