com.ibm.cics.model
Interface IExtrapartitionTDQueue

All Superinterfaces:
ICICSObject, ICICSResource, IInstalledCICSResource
All Known Subinterfaces:
IMutableExtrapartitionTDQueue

public interface IExtrapartitionTDQueue
extends ICICSResource, IInstalledCICSResource

generated from CICS resourcetable EXTRATDQ


Nested Class Summary
static class IExtrapartitionTDQueue.BlockFormatValue
          Enumeration type for field BLOCKFORMAT
static class IExtrapartitionTDQueue.ChangeAgentValue
          Enumeration type for field CHANGEAGENT
static class IExtrapartitionTDQueue.DispositionValue
          Enumeration type for field DISPOSITION
static class IExtrapartitionTDQueue.EmptyStatusValue
          Enumeration type for field EMPTYSTATUS
static class IExtrapartitionTDQueue.ErrorOptionValue
          Enumeration type for field ERROROPTION
static class IExtrapartitionTDQueue.InstallAgentValue
          Enumeration type for field INSTALLAGENT
static class IExtrapartitionTDQueue.IOTypeValue
          Enumeration type for field IOTYPE
static class IExtrapartitionTDQueue.OpenStatusValue
          Enumeration type for field OPENSTATUS
static class IExtrapartitionTDQueue.PrintControlValue
          Enumeration type for field PRINTCONTROL
static class IExtrapartitionTDQueue.RecordFormatValue
          Enumeration type for field RECORDFORMAT
static class IExtrapartitionTDQueue.RewindValue
          Enumeration type for field REWIND
static class IExtrapartitionTDQueue.StatusValue
          Enumeration type for field ENABLESTATUS
 
Method Summary
 java.lang.Long getBasdefinever()
          Getter for field BASDEFINEVER
 IExtrapartitionTDQueue.BlockFormatValue getBlockFormat()
          Getter for field BLOCKFORMAT
 java.lang.Long getBlockSize()
          Getter for field BLOCKSIZE
 IExtrapartitionTDQueue.ChangeAgentValue getChangeAgent()
          Getter for field CHANGEAGENT
 java.lang.String getChangeAgentRelease()
          Getter for field CHANGEAGREL
 java.util.Date getChangeTime()
          Getter for field CHANGETIME
 java.lang.String getChangeUserID()
          Getter for field CHANGEUSRID
 java.lang.Long getDataBuffers()
          Getter for field DATABUFFERS
 java.lang.String getDDName()
          Getter for field DDNAME
 java.lang.String getDefineSource()
          Getter for field DEFINESOURCE
 java.util.Date getDefineTime()
          Getter for field DEFINETIME
 IExtrapartitionTDQueue.DispositionValue getDisposition()
          Getter for field DISPOSITION
 java.lang.String getDSName()
          Getter for field DSNAME
 IExtrapartitionTDQueue.EmptyStatusValue getEmptyStatus()
          Getter for field EMPTYSTATUS
 IExtrapartitionTDQueue.ErrorOptionValue getErrorOption()
          Getter for field ERROROPTION
 IExtrapartitionTDQueue.InstallAgentValue getInstallAgent()
          Getter for field INSTALLAGENT
 java.util.Date getInstallTime()
          Getter for field INSTALLTIME
 java.lang.String getInstallUserID()
          Getter for field INSTALLUSRID
 IExtrapartitionTDQueue.IOTypeValue getIOType()
          Getter for field IOTYPE
 java.lang.String getMember()
          Getter for field MEMBER
 java.lang.String getName()
          Getter for field TDQUEUE
 IExtrapartitionTDQueue.OpenStatusValue getOpenStatus()
          Getter for field OPENSTATUS
 IExtrapartitionTDQueue.PrintControlValue getPrintControl()
          Getter for field PRINTCONTROL
 IExtrapartitionTDQueue.RecordFormatValue getRecordFormat()
          Getter for field RECORDFORMAT
 java.lang.Long getRecordLength()
          Getter for field RECORDLENGTH
 java.lang.Long getRequestCount()
          Getter for field OUTCNT
 IExtrapartitionTDQueue.RewindValue getRewind()
          Getter for field REWIND
 IExtrapartitionTDQueue.StatusValue getStatus()
          Getter for field ENABLESTATUS
 java.lang.String getSysoutClass()
          Getter for field SYSOUTCLASS
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 

Method Detail

getName

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

Queue ID

The name of the transient data queue.

Specified by:
getName in interface ICICSObject

getBlockFormat

IExtrapartitionTDQueue.BlockFormatValue getBlockFormat()
Getter for field BLOCKFORMAT

Block 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 EMPTYSTATUS

Empty status

Indicates the state of the queue:


getStatus

IExtrapartitionTDQueue.StatusValue getStatus()
Getter for field ENABLESTATUS

Enabled status

Indicates whether the queue can be accessed by applications.

Input Values: ENABLED, DISABLED


getIOType

IExtrapartitionTDQueue.IOTypeValue getIOType()
Getter for field IOTYPE

I/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 OPENSTATUS

Open status

Indicates whether the queue is open, closed, or in an intermediate state:

Input Values: OPEN, CLOSED


getPrintControl

IExtrapartitionTDQueue.PrintControlValue getPrintControl()
Getter for field PRINTCONTROL

Print control type

Indicates what type of print control applies to the records on this queue:


getRecordFormat

IExtrapartitionTDQueue.RecordFormatValue getRecordFormat()
Getter for field RECORDFORMAT

Record 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 RECORDLENGTH

Record 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 OUTCNT

Number 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 DDNAME

DD 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 DSNAME

Name of data set

Specifies the name of the associated QSAM data set or DUMMY data set.


getDisposition

IExtrapartitionTDQueue.DispositionValue getDisposition()
Getter for field DISPOSITION

Data 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 ERROROPTION

CICS action for I/O error

Indicates the action CICS should take if an I/O error is encountered. Valid values:


getRewind

IExtrapartitionTDQueue.RewindValue getRewind()
Getter for field REWIND

Rewind 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 BLOCKSIZE

Block length (bytes)

Indicates the length of the block in bytes.


getDataBuffers

java.lang.Long getDataBuffers()
Getter for field DATABUFFERS

Number 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 SYSOUTCLASS

SYSOUT class if spool file

Indicates the class attribute of the associated SYSOUT data set.


getMember

java.lang.String getMember()
Getter for field MEMBER

Member 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 CHANGEAGENT

Last modification agent

The change agent identifier that made the last modification.


getChangeUserID

java.lang.String getChangeUserID()
Getter for field CHANGEUSRID

Last modification user ID

The user ID that made the last modification to the resource definition.


getChangeAgentRelease

java.lang.String getChangeAgentRelease()
Getter for field CHANGEAGREL

Last 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 INSTALLAGENT

Installation agent

The change agent identifier that made the installation.


getChangeTime

java.util.Date getChangeTime()
Getter for field CHANGETIME

Last modification time

The local date and time when the definition was last changed.


getDefineSource

java.lang.String getDefineSource()
Getter for field DEFINESOURCE

Source 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 DEFINETIME

Creation 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 INSTALLUSRID

Installation user ID

The user ID that installed the resource definition.


getInstallTime

java.util.Date getInstallTime()
Getter for field INSTALLTIME

Installation time

The local date and time when the definition was installed.


getBasdefinever

java.lang.Long getBasdefinever()
Getter for field BASDEFINEVER

BAS resource definition version

The BAS version number of this definition.



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