com.ibm.cics.model
Interface ITDQueueDefinition

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

public interface ITDQueueDefinition
extends ICICSDefinition

generated from CICS resourcetable TDQDEF


Nested Class Summary
static class ITDQueueDefinition.AtifacilityValue
          Enumeration type for field ATIFACILITY
static class ITDQueueDefinition.BlockformatValue
          Enumeration type for field BLOCKFORMAT
static class ITDQueueDefinition.DispositionValue
          Enumeration type for field DISPOSITION
static class ITDQueueDefinition.ErroroptionValue
          Enumeration type for field ERROROPTION
static class ITDQueueDefinition.OpentimeValue
          Enumeration type for field OPENTIME
static class ITDQueueDefinition.PrintcontrolValue
          Enumeration type for field PRINTCONTROL
static class ITDQueueDefinition.RecordformatValue
          Enumeration type for field RECORDFORMAT
static class ITDQueueDefinition.RecovstatusValue
          Enumeration type for field RECOVSTATUS
static class ITDQueueDefinition.RewindValue
          Enumeration type for field REWIND
static class ITDQueueDefinition.TDQTypeValue
          Enumeration type for field TDQTYPE
static class ITDQueueDefinition.TypefileValue
          Enumeration type for field TYPEFILE
static class ITDQueueDefinition.WaitactionValue
          Enumeration type for field WAITACTION
static class ITDQueueDefinition.WaitValue
          Enumeration type for field WAIT
 
Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 ITDQueueDefinition.AtifacilityValue getAtifacility()
          Getter for field ATIFACILITY
 ITDQueueDefinition.BlockformatValue getBlockformat()
          Getter for field BLOCKFORMAT
 java.lang.Long getBlocksize()
          Getter for field BLOCKSIZE
 java.lang.Long getDatabuffers()
          Getter for field DATABUFFERS
 java.lang.String getDdname()
          Getter for field DDNAME
 ITDQueueDefinition.DispositionValue getDisposition()
          Getter for field DISPOSITION
 java.lang.String getDsname()
          Getter for field DSNAME
 ITDQueueDefinition.ErroroptionValue getErroroption()
          Getter for field ERROROPTION
 java.lang.String getFacilityid()
          Getter for field FACILITYID
 java.lang.String getIndirectname()
          Getter for field INDIRECTNAME
 ITDQueueDefinition.OpentimeValue getOpentime()
          Getter for field OPENTIME
 ITDQueueDefinition.PrintcontrolValue getPrintcontrol()
          Getter for field PRINTCONTROL
 ITDQueueDefinition.RecordformatValue getRecordformat()
          Getter for field RECORDFORMAT
 java.lang.Long getRecordsize()
          Getter for field RECORDSIZE
 ITDQueueDefinition.RecovstatusValue getRecovstatus()
          Getter for field RECOVSTATUS
 java.lang.Long getRemotelength()
          Getter for field REMOTELENGTH
 java.lang.String getRemotename()
          Getter for field REMOTENAME
 java.lang.String getRemotesystem()
          Getter for field REMOTESYSTEM
 ITDQueueDefinition.RewindValue getRewind()
          Getter for field REWIND
 java.lang.String getSysoutclass()
          Getter for field SYSOUTCLASS
 ITDQueueDefinition.TDQTypeValue getTDQType()
          Getter for field TDQTYPE
 java.lang.String getTermid()
          Getter for field TERMID
 java.lang.String getTransid()
          Getter for field TRANSID
 java.lang.Long getTriggerlevel()
          Getter for field TRIGGERLEVEL
 ITDQueueDefinition.TypefileValue getTypefile()
          Getter for field TYPEFILE
 java.lang.String getUserdata1()
          Getter for field USERDATA1
 java.lang.String getUserdata2()
          Getter for field USERDATA2
 java.lang.String getUserdata3()
          Getter for field USERDATA3
 java.lang.String getUserid()
          Getter for field USERID
 ITDQueueDefinition.WaitValue getWait()
          Getter for field WAIT
 ITDQueueDefinition.WaitactionValue getWaitaction()
          Getter for field WAITACTION
 
Methods inherited from interface com.ibm.cics.model.ICICSDefinition
getChangeAgent, getChangeAgentRelease, getChangeTime, getChangeUserID, getCreateTime, getCSDGroup, getDescription, getVersion
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName, getObjectType
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getBlockformat

ITDQueueDefinition.BlockformatValue getBlockformat()
Getter for field BLOCKFORMAT

Block option

(Extrapartition queues only) The block format of the data set. There is no default. If you specify the record format (RECORDFORMAT attribute) as undefined (or allow it to default), you cannot specify anything for the BLOCKFORMAT attribute. Options are:


getRecordformat

ITDQueueDefinition.RecordformatValue getRecordformat()
Getter for field RECORDFORMAT

Record format

Indicates whether the queue has fixed- or variable-length records:


getDisposition

ITDQueueDefinition.DispositionValue getDisposition()
Getter for field DISPOSITION

Disposition

The disposition of the data set (extrapartition queues only):


getErroroption

ITDQueueDefinition.ErroroptionValue getErroroption()
Getter for field ERROROPTION

Error option

The action to be taken if an I/O error occurs (extrapartition queues only). This can be one of the following:


getOpentime

ITDQueueDefinition.OpentimeValue getOpentime()
Getter for field OPENTIME

Data set open time

(Extrapartition queues only.) The initial status of the data set. Options are:


getPrintcontrol

ITDQueueDefinition.PrintcontrolValue getPrintcontrol()
Getter for field PRINTCONTROL

Printer control

(Extrapartition queues only.) The control characters to be used:


getRewind

ITDQueueDefinition.RewindValue getRewind()
Getter for field REWIND

Tape disposition

The disposition of a tape data set (extrapartition queues only). The disposition can be one of the following:


getAtifacility

ITDQueueDefinition.AtifacilityValue getAtifacility()
Getter for field ATIFACILITY

Destination type

The type of destination the queue represents:


getRecovstatus

ITDQueueDefinition.RecovstatusValue getRecovstatus()
Getter for field RECOVSTATUS

Recovery option

The type of recovery defined for the queue (intrapartition queues only):


getWait

ITDQueueDefinition.WaitValue getWait()
Getter for field WAIT

Wait for UOW resynchronization

Specifies whether an in-doubt unit of work (UOW) that has modified a logically recoverable queue should wait for resynchronization with its coordinator to determine whether to commit or back out the changes (intrapartition queues only):


getWaitaction

ITDQueueDefinition.WaitactionValue getWaitaction()
Getter for field WAITACTION

In-doubt UOW wait action

The action CICS is to take for an in-doubt unit of work (UOW) if the definition for this queue specifies WAIT(YES) (intrapartition queues only). The possible actions are:


getTypefile

ITDQueueDefinition.TypefileValue getTypefile()
Getter for field TYPEFILE

Data set type

The type of data set the queue is to be associated with:


getBlocksize

java.lang.Long getBlocksize()
Getter for field BLOCKSIZE

Block size

(Extrapartition queues only.) The length of the block, in bytes. The block length should be in the range 0 through 32767. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.


getRecordsize

java.lang.Long getRecordsize()
Getter for field RECORDSIZE

Record size

The record length (in bytes) for queues having fixed-length records, or the maximum record length for queues having variable-length records. This field applies only to extrapartition queues; for others, -1 is returned.


getDatabuffers

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

Number of buffers

The number of buffers to be provided, up to a maximum of 255. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.


getTriggerlevel

java.lang.Long getTriggerlevel()
Getter for field TRIGGERLEVEL

Trigger level

The number of records to be accumulated before a task is automatically initiated to process them. Specify a trigger level of 0 if you want to disable ATI processing. If you do not specify a transaction ID, the trigger level is ignored. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.


getRemotelength

java.lang.Long getRemotelength()
Getter for field REMOTELENGTH

Remote length

(Optional.) The length in bytes, in the range 1 through 32767. The default value is 1. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.


getTDQType

ITDQueueDefinition.TDQTypeValue getTDQType()
Getter for field TDQTYPE

Transient data queue (TDQ) type

The type of queue:


getSysoutclass

java.lang.String getSysoutclass()
Getter for field SYSOUTCLASS

System output (SYSOUT) class

Instead of allocating an extrapartition queue to a physical data set, you can allocate it to a system output data set (referred to as SYSOUT). Use the SYSOUTCLASS attribute to specify the class of the SYSOUT data set.


getDdname

java.lang.String getDdname()
Getter for field DDNAME

DD name

A 1 to 8 character value that refers to the data definition (DD) statement associated with the extrapartition TD queue. If a DD statement of this name is not coded in the JCL of the CICS region, then this name will be used to dynamically allocate the data set or sysout file.


getDsname

java.lang.String getDsname()
Getter for field DSNAME

DS name

A 1 to 44 character value that identifies the data set (DS) name to be dynamically allocated to the extrapartition TD queue. This value will be ignored if the DD name value specified is coded as a DD statement in the JCL of the CICS region.


getFacilityid

java.lang.String getFacilityid()
Getter for field FACILITYID

Facility identifier

A 4-character field that contains either:

If you do not specify anything in the FACILITYID field, it defaults to the name of the queue in each case. This field must be left blank if FILE is specified for the ATIFACILITY attribute.


getTransid

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

Transaction started at trigger level

The name of the transaction that is to be automatically initiated when the trigger level is reached. Transactions are initiated in this way to read records from the queue. If the TRANSID attribute is not specified (or if 0 is specified for the TRIGGERLEVEL attribute), you must use another method to schedule transactions to read records from transient data queues.


getUserid

java.lang.String getUserid()
Getter for field USERID

User ID on the triggered transaction

The user ID you want CICS to use for security checking when verifying the trigger-level transaction specified in the TRANSID field (intrapartition queues only).


getIndirectname

java.lang.String getIndirectname()
Getter for field INDIRECTNAME

Indirect transient data queue (TDQ) name

The name of a transient data queue. The queue can be intrapartition, extrapartition, remote, or indirect.


getRemotename

java.lang.String getRemotename()
Getter for field REMOTENAME

Remote transient data queue (TDQ) name

the 4-character name of this queue in the remote CICS region in which the queue is defined (from the RMTNAME option in its definition). REMOTENAME applies only to queues defined as remote; for other queues the value returned is blanks.


getRemotesystem

java.lang.String getRemotesystem()
Getter for field REMOTESYSTEM

System identifier of remote destination

(Optional.) Specifies, if the transient data queue resides on a remote system, the name of the connection that links the target (local) system to the related (remote) system where the transient data queue resides. If this attribute is not supplied, it is derived directly from the CICS system ID of the related system, and the connection that links the target system to the related system must have the same name as the CICS system ID of the related system.


getTermid

java.lang.String getTermid()
Getter for field TERMID

Terminal name

The ID of the terminal.


getUserdata1

java.lang.String getUserdata1()
Getter for field USERDATA1

User data area 1

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.


getUserdata2

java.lang.String getUserdata2()
Getter for field USERDATA2

User data area 2

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.


getUserdata3

java.lang.String getUserdata3()
Getter for field USERDATA3

User data area 3

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.



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