Interface ICICSSharedTSQueue
-
- All Superinterfaces:
ICICSObject
,ICICSResource
,com.ibm.cics.model.meta.ITypedObject
public interface ICICSSharedTSQueue extends ICICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ICICSSharedTSQueue.LocationValue
Enumeration type for field LOCATIONstatic class
ICICSSharedTSQueue.RecovstatusValue
Enumeration type for field RECOVSTATUS
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ICICSSharedTSQueueReference
getCICSObjectReference()
java.lang.Long
getExpiryint()
Getter for field EXPIRYINTjava.lang.Long
getExpiryintmin()
Getter for field EXPIRYINTMINjava.lang.String
getHexname()
Getter for field HEXNAMEjava.lang.Long
getItemCount()
Getter for field NUMITEMSjava.lang.Long
getLastusedint()
Getter for field LASTUSEDINTICICSSharedTSQueue.LocationValue
getLocation()
Getter for field LOCATIONjava.lang.Long
getMaxItemLength()
Getter for field MAXITEMLENjava.lang.Long
getMinItemLength()
Getter for field MINITEMLENjava.lang.String
getName()
Getter for field NAMEICICSType<ICICSSharedTSQueue>
getObjectType()
java.lang.String
getPoolname()
Getter for field POOLNAMEjava.lang.Long
getQueueLength()
Getter for field QUELENGTHICICSSharedTSQueue.RecovstatusValue
getRecovstatus()
Getter for field RECOVSTATUSjava.lang.String
getTransid()
Getter for field TRANSIDjava.lang.String
getTSModel()
Getter for field TSMODEL-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
-
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSContainer, getCICSRelease, getRegionName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<ICICSSharedTSQueue> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getName
java.lang.String getName()
Getter for field NAMEQueue name
The name of the shared temporary storage queue.
- Specified by:
getName
in interfaceICICSObject
-
getPoolname
java.lang.String getPoolname()
Getter for field POOLNAMETemporary storage pool name
The name of a temporary storage pool. CICS ships the command to the temporary storage server that manages the pool.
-
getLocation
ICICSSharedTSQueue.LocationValue getLocation()
Getter for field LOCATIONQueue location
Indicates where the shared temporary storage queue resides.
-
getQueueLength
java.lang.Long getQueueLength()
Getter for field QUELENGTHTotal queue length (bytes)
The total length, in bytes, of all the items in the shared temporary storage queue.
If an AUXILIARY TSQSHR 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 MAXITEMLENLargest item length (bytes)
The length, in bytes, of the largest item in the shared temporary storage queue.
Note: If an AUXILIARY TSQSHR 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.
-
getMinItemLength
java.lang.Long getMinItemLength()
Getter for field MINITEMLENSmallest item length (bytes)
The length, in bytes, of the smallest item in the shared temporary storage queue.
If an AUXILIARY TSQSHR 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 NUMITEMSNumber of items in queue
The number of items in the shared temporary storage queue.
-
getLastusedint
java.lang.Long getLastusedint()
Getter for field LASTUSEDINTInterval since queue last used (seconds)
The interval, in seconds, since the shared temporary storage queue was last referenced.
-
getTransid
java.lang.String getTransid()
Getter for field TRANSIDTransaction that created TS queue
The ID of the transaction that created the shared temporary storage queue.
-
getRecovstatus
ICICSSharedTSQueue.RecovstatusValue getRecovstatus()
Getter for field RECOVSTATUSRecovery status
Indicates whether or not the shared temporary storage queue is recoverable.
-
getExpiryint
java.lang.Long getExpiryint()
Getter for field EXPIRYINTTS Queue expiry interval (hours)
The last used interval limit time, in hours, which is used to determine whether a temporary storage queue has expired and is eligible to be automatically deleted. The value is derived from the EXPIRYINT value in the TSMODEL, or for CICS TS 5.2 and higher either the EXPIRYINT value or the EXPIRYINTMIN value rounded up to the next hour. The EXPIRYINTMIN value overrides EXPIRYINT. 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.
- 0 - Indicates that no expiry interval applies to this TSMODEL and therefore a temporary storage queue based on this will never expire. This is the default value.
- value - Specifies the last used interval in hours after which the queue becomes eligible for automatic deletion.
-
getExpiryintmin
java.lang.Long getExpiryintmin()
Getter for field EXPIRYINTMINTS Queue expiry interval (minutes)
The last used interval limit time, in minutes, which is used to determine whether a temporary storage queue has expired and is eligible to be automatically deleted. CICS rounds up the value to a multiple of ten minutes. 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 EXPIRYINTMIN can be in the range of 0-to-900000.
- 0 - Indicates that no expiry interval applies to this TS queue. This is the default value.
- value - Specifies the last used interval in minutes after which the queue becomes eligible for automatic deletion.
-
getTSModel
java.lang.String getTSModel()
Getter for field TSMODELTS Model
The name of the TS model which was used when the queue was created. Some properties of the queue are set at creation time from the TS model. If the TS model is subsequently altered or deleted, this has no effect on the TS queue.
-
getHexname
java.lang.String getHexname()
Getter for field HEXNAMEQueue name in hexadecimal
The name of the temporary storage queue in hexadecimal.
-
getCICSObjectReference
ICICSSharedTSQueueReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICICSResource
-
-