com.ibm.cics.model

Interface ITDQueueDefinition

    • 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:

        • BLOCKED - Blocked record format.
        • UNBLOCKED - Unblocked record format.
        • NOTAPPLIC - No block format is defined for this data set.
      • getRecordformat

        ITDQueueDefinition.RecordformatValue getRecordformat()
        Getter for field RECORDFORMAT

        Record format

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

        • FIXED - The queue has fixed-length records.
        • UNDEFINED - The queue is not open or is not extrapartition.
        • VARIABLE - The queue has variable-length records.
      • getDisposition

        ITDQueueDefinition.DispositionValue getDisposition()
        Getter for field DISPOSITION

        Disposition

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

        • MOD - CICS first assumes that the data set exists. For an existing sequential data set, MOD causes the read/write mechanism to be positioned after the last record in the data set. The read/write mechanism is positioned after the last record each time the data set is opened for output.
        • OLD - The data set existed before this job step.
        • SHR - The data set existed before this job step and can be read by other concurrent jobs
      • 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:

        • IGNORE - The block that caused the error is accepted.
        • SKIP - The block that caused the error is skipped.
      • getOpentime

        ITDQueueDefinition.OpentimeValue getOpentime()
        Getter for field OPENTIME

        Data set open time

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

        • DEFERRED - The data set remains closed until you indicate that you want to open it by using the CEMT INQUIRE|SET TDQUEUE command.
        • INITIAL - The data set is to be opened at install time.
      • getPrintcontrol

        ITDQueueDefinition.PrintcontrolValue getPrintcontrol()
        Getter for field PRINTCONTROL

        Printer control

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

        • ASA - ASA control characters.
        • MACHINE - Machine control characters.
        • N/A - The Printcontrol value does not apply to this definition and should not be validated.
      • 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:

        • LEAVE - The current tape is positioned at the logical end of the data set.
        • REREAD - The current tape is positioned at the logical start of the data set.
        • NOTAPPLIC - This is not applicable for this resource.
      • getAtifacility

        ITDQueueDefinition.AtifacilityValue getAtifacility()
        Getter for field ATIFACILITY

        Destination type

        The type of destination the queue represents:

        • TERMINAL - The transient data queue is to be associated with the terminal. The terminal must be defined to CICS. If you do not specify TERMINAL, it defaults to the value of FACILITYID. If ATI is used, as specified in the TRANSID and TRIGGERLEVEL attributes, the transaction that is initiated is associated with the specified terminal, which must be available before the transaction can be initiated.
        • FILE - The transient data queue is to be used as a file of data records that are not associated with a particular terminal or system. ATI does not require a terminal to be available.
        • SYSTEM - The transient data queue is to be associated with the specified system identifier. The system must be defined to the local CICS system using an RDO CONNECTION definition.
      • getRecovstatus

        ITDQueueDefinition.RecovstatusValue getRecovstatus()
        Getter for field RECOVSTATUS

        Recovery option

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

        • LOGICAL - The queue is logically recoverable. If a transaction that accessed this queue was in-flight at the time of abnormal termination, or in the subsequent emergency restart or dynamic transaction backout, the queue is restored to the status it was in before the in-flight UOW modified it.
        • NOTAPPLIC - The queue is not intrapartition.
        • NO - The queue is not recoverable.
        • PHYSICAL - The queue is physically recoverable. If emergency restart occurs, this queue is to be recovered to its status at the time CICS terminated.
      • 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):

        • NO - The UOW is not to wait. Any changes made to recoverable resources are to be backed out or committed, as specified by the ACTION attribute on the TRANSACTION resource definition.
        • YES - The UOW is to wait, and any action required while waiting is determined by the WAITACTION attribute.
        • N/A - The Wait field does not apply to this definition.
      • 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:

        • QUEUE - The UOW is in-doubt and waiting; any locks held by the UOW for this queue remain active until the final state of the UOW is known. This means that tasks are suspended rather than receiving the LOCKED response. When the final state of the UOW is known, any changes that it has made are committed or backed out. Until then, any further requests of the following types that need one of the active locks must wait: READQ, if the in-doubt UOW had issued READQ or DELETEQ requests. WRITEQ, if the in-doubt UOW had issued WRITEQ or DELETEQ requests. DELETEQ, if the in-doubt UOW had issued READQ, WRITEQ or DELETEQ requests.
        • REJECT - The UOW is in-doubt and is waiting. Any lock held by the UOW for this queue is retained until the final state of the UOW is known. When the final state is known, any changes the UOW has made are committed or backed out. Until then, any further request that needs one of the retained locks is rejected, and a LOCKED response is returned. WAITACTION=REJECT causes LOCKED to be raised in exactly the same circumstances as those in which QUEUE causes a transaction to wait.
        • N/A - This field does not apply to this definition and should not be validated.
      • getTypefile

        ITDQueueDefinition.TypefileValue getTypefile()
        Getter for field TYPEFILE

        Data set type

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

        • INPUT - An input data set.
        • OUTPUT - An output data set.
        • RDBACK - An input data set that is to be read backward.
      • 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:

        • EXTRA - A queue that is outside the CICS region is allocated to CICS.
        • INDIRECT - An indirect queue is a queue that does not point to an actual data set, but to another queue. An indirect queue can be extrapartition, intrapartition, remote, or even another indirect queue.
        • INTRA - A queue for data that is to be stored temporarily.
        • REMOTE - A queue that is located on a remote system.
      • 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.

        • A..Z|0..9 - A single alphabetic or numeric character that represents an output class that has been set up on the z/OS system on which the CICS job is to run.
        • - This is the default class. SYSOUTCLASS defaults to an asterisk (*) if you leave the DSNAME attribute blank and specify OUTPUT for the TYPEFILE field.
        • blank - SYSOUTCLASS defaults to a blank character if you leave the DSNAME attribute blank and specify INPUT or RDBACK for the TYPEFILE attribute.
      • 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:

        • The system identifier for an intrapartition queue that specifies ATIFACILITY as SYSTEM.
        • The terminal identifier where ATIFACILITY is TERMINAL.
        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.

      • getJobuserid

        java.lang.String getJobuserid()
        Getter for field JOBUSERID

        Default job user ID for jobs to JES internal rdr

        If the USER= option is not specified on the JOB card for JCL submitted to the JES internal reader using this TDQ a USER= option with the value specified will be added to the JOB card used. If the value is blank the region user ID will be used. (extrapartition queues only).

Copyright ? 2008-2015 IBM Corp. All Rights Reserved.