Interface IExtrapartitionTDQueue
-
- All Superinterfaces:
ICICSObject
,ICICSResource
,IInstalledCICSResource
,com.ibm.cics.model.meta.ITypedObject
public interface IExtrapartitionTDQueue extends ICICSResource, IInstalledCICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IExtrapartitionTDQueue.BlockFormatValue
Enumeration type for field BLOCKFORMATstatic class
IExtrapartitionTDQueue.ChangeAgentValue
Enumeration type for field CHANGEAGENTstatic class
IExtrapartitionTDQueue.DispositionValue
Enumeration type for field DISPOSITIONstatic class
IExtrapartitionTDQueue.EmptyStatusValue
Enumeration type for field EMPTYSTATUSstatic class
IExtrapartitionTDQueue.ErrorOptionValue
Enumeration type for field ERROROPTIONstatic class
IExtrapartitionTDQueue.InstallAgentValue
Enumeration type for field INSTALLAGENTstatic class
IExtrapartitionTDQueue.IOTypeValue
Enumeration type for field IOTYPEstatic class
IExtrapartitionTDQueue.OpenStatusValue
Enumeration type for field OPENSTATUSstatic class
IExtrapartitionTDQueue.PrintControlValue
Enumeration type for field PRINTCONTROLstatic class
IExtrapartitionTDQueue.RecordFormatValue
Enumeration type for field RECORDFORMATstatic class
IExtrapartitionTDQueue.RewindValue
Enumeration type for field REWINDstatic class
IExtrapartitionTDQueue.StatusValue
Enumeration type for field ENABLESTATUS
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
-
Fields inherited from interface com.ibm.cics.model.IInstalledCICSResource
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Long
getBasdefinever()
Getter for field BASDEFINEVERIExtrapartitionTDQueue.BlockFormatValue
getBlockFormat()
Getter for field BLOCKFORMATjava.lang.Long
getBlockSize()
Getter for field BLOCKSIZEIExtrapartitionTDQueue.ChangeAgentValue
getChangeAgent()
Getter for field CHANGEAGENTjava.lang.String
getChangeAgentRelease()
Getter for field CHANGEAGRELjava.util.Date
getChangeTime()
Getter for field CHANGETIMEjava.lang.String
getChangeUserID()
Getter for field CHANGEUSRIDIExtrapartitionTDQueueReference
getCICSObjectReference()
java.lang.Long
getDataBuffers()
Getter for field DATABUFFERSjava.lang.String
getDDName()
Getter for field DDNAMEjava.lang.String
getDefineSource()
Getter for field DEFINESOURCEjava.util.Date
getDefineTime()
Getter for field DEFINETIMEIExtrapartitionTDQueue.DispositionValue
getDisposition()
Getter for field DISPOSITIONjava.lang.String
getDSName()
Getter for field DSNAMEIExtrapartitionTDQueue.EmptyStatusValue
getEmptyStatus()
Getter for field EMPTYSTATUSIExtrapartitionTDQueue.ErrorOptionValue
getErrorOption()
Getter for field ERROROPTIONIExtrapartitionTDQueue.InstallAgentValue
getInstallAgent()
Getter for field INSTALLAGENTjava.util.Date
getInstallTime()
Getter for field INSTALLTIMEjava.lang.String
getInstallUserID()
Getter for field INSTALLUSRIDIExtrapartitionTDQueue.IOTypeValue
getIOType()
Getter for field IOTYPEjava.lang.String
getMember()
Getter for field MEMBERjava.lang.String
getName()
Getter for field TDQUEUEICICSType<IExtrapartitionTDQueue>
getObjectType()
IExtrapartitionTDQueue.OpenStatusValue
getOpenStatus()
Getter for field OPENSTATUSIExtrapartitionTDQueue.PrintControlValue
getPrintControl()
Getter for field PRINTCONTROLIExtrapartitionTDQueue.RecordFormatValue
getRecordFormat()
Getter for field RECORDFORMATjava.lang.Long
getRecordLength()
Getter for field RECORDLENGTHjava.lang.Long
getRequestCount()
Getter for field OUTCNTIExtrapartitionTDQueue.RewindValue
getRewind()
Getter for field REWINDIExtrapartitionTDQueue.StatusValue
getStatus()
Getter for field ENABLESTATUSjava.lang.String
getSysoutClass()
Getter for field SYSOUTCLASS-
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<IExtrapartitionTDQueue> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getName
java.lang.String getName()
Getter for field TDQUEUEQueue ID
The name of the transient data queue.
- Specified by:
getName
in interfaceICICSObject
-
getBlockFormat
IExtrapartitionTDQueue.BlockFormatValue getBlockFormat()
Getter for field BLOCKFORMATBlock format
Indicates whether the queue is blocked or unblocked. A value of NOTAPPLIC is returned if the queue is not open.
-
getEmptyStatus
IExtrapartitionTDQueue.EmptyStatusValue getEmptyStatus()
Getter for field EMPTYSTATUSEmpty status
Indicates the state of the queue:
- FULL - The queue is full.
- EMPTY - The queue is empty.
- NOTEMPTY - No operation against the queue has indicated that it is either empty or full.
- NOTAPPLIC - The queue is not open.
-
getStatus
IExtrapartitionTDQueue.StatusValue getStatus()
Getter for field ENABLESTATUSEnabled status
Indicates whether the queue can be accessed by applications.
Input Values: ENABLED, DISABLED
-
getIOType
IExtrapartitionTDQueue.IOTypeValue getIOType()
Getter for field IOTYPEI/O type
Indicates whether the queue was defined for INPUT, OUTPUT, or RDBACK, which means the queue can be read backwards.
-
getOpenStatus
IExtrapartitionTDQueue.OpenStatusValue getOpenStatus()
Getter for field OPENSTATUSOpen status
Indicates whether the queue is open, closed, or in an intermediate state:
- OPENING - The queue is in the process of being opened.
- OPEN - The queue is open.
- CLOSING - The queue is in the process of being closed.
- CLOSED - The queue is closed.
- SWITCHING - The queue is unavailable, undergoing volume (extent) switching.
Input Values: OPEN, CLOSED
-
getPrintControl
IExtrapartitionTDQueue.PrintControlValue getPrintControl()
Getter for field PRINTCONTROLPrint control type
Indicates what type of print control applies to the records on this queue:
- ASACTL or ASA - ASA control character
- MCHCTL or MCH - Machine control character
- NOCTL or NOC - No print control
- NOTAPPLIC or NOT - The queue is not open.
-
getRecordFormat
IExtrapartitionTDQueue.RecordFormatValue getRecordFormat()
Getter for field RECORDFORMATRecord format
Indicates whether the queue has fixed-length (FIXED) or variable-length (VARIABLE) records. A value of NOTAPPLIC is returned if the queue is not open.
-
getRecordLength
java.lang.Long getRecordLength()
Getter for field RECORDLENGTHRecord length (bytes)
For queues with variable-length records (VARIABLE), the maximum record length in bytes. For queues with fixed-length records (FIXED), the actual record length in bytes. A value of N/A means the record length could not be determined because the queue is closed.
-
getRequestCount
java.lang.Long getRequestCount()
Getter for field OUTCNTNumber of READ and WRITE requests
The number of WRITEs to the output data set or READs from the input data set.
-
getDDName
java.lang.String getDDName()
Getter for field DDNAMEDD name on JCL statement defining data set
The identifier that may refer to a data set name used in the start up JCL.
-
getDSName
java.lang.String getDSName()
Getter for field DSNAMEName of data set
Specifies the name of the associated QSAM data set or DUMMY data set.
-
getDisposition
IExtrapartitionTDQueue.DispositionValue getDisposition()
Getter for field DISPOSITIONData set disposition
Indicates the disposition of the data set as MOD, OLD or SHARE. NOTAPPLIC is returned if the queue is not open.
-
getErrorOption
IExtrapartitionTDQueue.ErrorOptionValue getErrorOption()
Getter for field ERROROPTIONCICS action for I/O error
Indicates the action CICS should take if an I/O error is encountered. Valid values:
- IGNORERR - The block that caused the error is accepted.
- SKIP - The block that caused the error is skipped.
- NOTAPPLIC - The action is not applicable to this queue.
-
getRewind
IExtrapartitionTDQueue.RewindValue getRewind()
Getter for field REWINDRewind action when data set on tape closed
Indicates that the current tape is positioned to the logical end of the data set (LEAVE) or positioned to reprocess the data set (REREAD). NOTAPPLIC will be used if REWIND is not applicable for this resource.
-
getBlockSize
java.lang.Long getBlockSize()
Getter for field BLOCKSIZEBlock length (bytes)
Indicates the length of the block in bytes.
-
getDataBuffers
java.lang.Long getDataBuffers()
Getter for field DATABUFFERSNumber of data buffers to be used
Indicates the number of buffers to be used by the transient data queue.
-
getSysoutClass
java.lang.String getSysoutClass()
Getter for field SYSOUTCLASSSYSOUT class if spool file
Indicates the class attribute of the associated SYSOUT data set.
-
getMember
java.lang.String getMember()
Getter for field MEMBERMember name
This indicates the member name of a partitioned data set. However if the QSAM data set is not a partitioned data set then this field will be blank..
-
getChangeAgent
IExtrapartitionTDQueue.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENTLast modification agent
The change agent identifier that made the last modification.
- CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
- CSDBATCH - The resource was last changed by a DFHCSDUP job.
- DREPAPI - The resource was last changed by a CICSPlex SM BAS API command.
- DREPBATCH - The resource was last changed by a CICSPlex SM utility.
- SYSTEM - The resource was last changed by the CICS or CICSPlex SM system.
- CREATESPI - The resource was last changed by an EXEC CICS CREATE command.
- NOTAPPLIC - This is not applicable for this resource.
- OVERRIDE - Resource was last changed by resource overrides.
- N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
-
getChangeUserID
java.lang.String getChangeUserID()
Getter for field CHANGEUSRIDLast modification user ID
The user ID that made the last modification to the resource definition.
-
getChangeAgentRelease
java.lang.String getChangeAgentRelease()
Getter for field CHANGEAGRELLast modification agent release
The CICS release level of the agent that made the last modification to the resource definition.
-
getInstallAgent
IExtrapartitionTDQueue.InstallAgentValue getInstallAgent()
Getter for field INSTALLAGENTInstallation agent
The install agent identifier that made the installation.
- CSDAPI - The resource was installed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
- CREATESPI - The resource was installed by an EXEC CICS CREATE command.
- GRPLIST - The resource was installed by GRPLIST INSTALL.
- SYSTEM - The resource was last installed by the CICS or CICSPlex SM system.
-
getChangeTime
java.util.Date getChangeTime()
Getter for field CHANGETIMELast modification time
The local date and time when the definition was last changed.
-
getDefineSource
java.lang.String getDefineSource()
Getter for field DEFINESOURCESource of the resource definition
The source of the definition, depending on which agent made the last change.
-
getDefineTime
java.util.Date getDefineTime()
Getter for field DEFINETIMECreation time
The local date and time when the resource definition record was created on DFHCSD or EYUDREP.
-
getInstallUserID
java.lang.String getInstallUserID()
Getter for field INSTALLUSRIDInstallation user ID
The user ID that installed the resource definition.
-
getInstallTime
java.util.Date getInstallTime()
Getter for field INSTALLTIMEInstallation time
The local date and time when the definition was installed.
-
getBasdefinever
java.lang.Long getBasdefinever()
Getter for field BASDEFINEVERBAS resource definition version
The BAS version number of this definition.
-
getCICSObjectReference
IExtrapartitionTDQueueReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICICSResource
-
-