com.ibm.cics.model
Interface ITSQueue

All Superinterfaces:
ICICSObject, ICICSResource, com.ibm.cics.model.meta.ITypedObject

public interface ITSQueue
extends ICICSResource

generated from CICS resourcetable TSQNAME


Nested Class Summary
static class ITSQueue.LocationValue
          Enumeration type for field LOCATION
static class ITSQueue.RecovstatusValue
          Enumeration type for field RECOVSTATUS
 
Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.lang.Long getExpiryint()
          Getter for field EXPIRYINT
 java.lang.String getHexname()
          Getter for field HEXNAME
 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
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getObjectType
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
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

Indicates where the temporary storage queue resides. Values are:


getQueueLength

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

Total queue length (bytes)

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

Note: If an AUXILIARY TSQNAME 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 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 item length (bytes)

The length in bytes of the smallest item in the temporary storage queue. For information about how CICS calculates the length of items, and for information about shared TS queues, see the MAXITEMLEN option.


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.

The value returned for large shared temporary storage queues is governed by the value of the LASTUSEDINTERVAL parameter specified for the associated TS queue manager.


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

Indicates whether or not the temporary storage queue is recoverable. Options are RECOVERABLE or NOTRECOVERABLE.


getExpiryint

java.lang.Long getExpiryint()
Getter for field EXPIRYINT

TS Queue expiry interval (hours)

This parameter specifies the last used interval limit time, in hours, which is used to determine whether a temporary storage queue based on this TSMODEL has expired and is eligible to be automatically deleted. The value in the TSMODEL at the time a temporary storage queue is created will be used for the lifetime of a queue even if the TSMODEL is subsequently changed. The value of EXPIRYINT can be in the range of 0-to-15000.


getHexname

java.lang.String getHexname()
Getter for field HEXNAME

Queue name in hexadecimal

The name of the temporary storage queue in hexadecimal.



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