com.ibm.cics.model

Interface IDataTable

    • Method Detail

      • getName

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

        File ID

        The name of the data table file

        Specified by:
        getName in interface ICICSObject
      • getAdd

        IDataTable.AddValue getAdd()
        Getter for field ADD

        Add option

        Indicates whether new records can be added to the data table file.

        Input Values: ADDABLE, NOTADDABLE

      • getBrowse

        IDataTable.BrowseValue getBrowse()
        Getter for field BROWSE

        Browse option

        Indicates whether records in the data table file can be browsed.

        Input Values: BROWSABLE, NOTBROWSABLE

      • getDelete

        IDataTable.DeleteValue getDelete()
        Getter for field DELETE

        Delete option

        Indicates whether records can be deleted from the data table file.

        Input Values: DELETABLE, NOTDELETABLE

      • getDisposition

        IDataTable.DispositionValue getDisposition()
        Getter for field DISPOSITION

        Disposition of associated data set

        The disposition of the data table file.

        Input Values: OLD, SHARE

      • getDsname

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

        Data set name

        The 44-character name of the data set associated with this data table file, as defined to the access method and to the operating system.

        Input Values: Any valid data set name

      • getStatus

        IDataTable.StatusValue getStatus()
        Getter for field ENABLESTATUS

        Enablement status

        Indicates whether the data table file is available for access by application programs. The status will be one of the following options:

        • ENABLED - Available for access.
        • DISABLED - Not available for access, as a result of a disable command.
        • DISABLING - Still being accessed after a disable or close command.
        • UNENABLED - Not available for access, as a result of a close command.
        • UNENABLING - A request to close the file has been received, but tasks are executing that had previously accessed the file. These tasks are allowed to complete their use of the file, but new tasks are not allowed access.

      • getForwardRecoveryStatus

        IDataTable.ForwardRecoveryStatusValue getForwardRecoveryStatus()
        Getter for field FWDRECSTATUS

        Forward recovery option

        Indicates whether the data table file is forward-recoverable. Values are FWDRECOVABLE or NOTFWDRCVBLE

      • getKeyLength

        java.lang.Long getKeyLength()
        Getter for field KEYLENGTH

        Key length

        The length of the key

      • getKeyPosition

        java.lang.Long getKeyPosition()
        Getter for field KEYPOSITION

        Key position

        The starting position of the key field in each record relative to the beginning of the record

      • getMaxnumrecs

        java.lang.Long getMaxnumrecs()
        Getter for field MAXNUMRECS

        Maximum number of records table can hold

        This is maximum number of records that the data table file can hold in the range from 0 to 99,999,999. A value of 0 implies that the table has no logical limit to its size, although in practical terms there is an architectural system limit of 2,147,483,647. Care should be taken when specifying 'NOLIMIT', because a transaction in a runaway task state will not be prevented from filling up storage in the Coupling Facility Dataspace.

        Input Values: 0 - 99,999,999

      • getOpenstatus

        IDataTable.OpenstatusValue getOpenstatus()
        Getter for field OPENSTATUS

        Open status

        Indicates whether the data table file is open, closed, or in transition.

        Input Values: OPEN, CLOSED

      • getRead

        IDataTable.ReadValue getRead()
        Getter for field READ

        Read option

        Indicates whether records can be read from the data table file

        Input Values: READABLE, NOTREADABLE

      • getRecordFormat

        IDataTable.RecordFormatValue getRecordFormat()
        Getter for field RECORDFORMAT

        Record format

        The format of the records in the data table file: Values are: FIXED, VARIABLE, or UNDEFINED

      • getRecordsize

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

        Record size

        For fixed-length records, the actual size of a record. For variable-length records, the maximum size of a record

      • getRecovstatus

        IDataTable.RecovstatusValue getRecovstatus()
        Getter for field RECOVSTATUS

        Recovery type

        Indicates whether the data table file is recoverable. Values are: RECOVERABLE or NOTRECOVABLE

      • getStrings

        java.lang.Long getStrings()
        Getter for field STRINGS

        Number of strings

        The total number of operations that can be performed on the data table file at one time.

        Input Values: 1 - 255

      • getTable

        IDataTable.TableValue getTable()
        Getter for field TABLE

        Type of data table

        Indicates whether the data table associated with the file is a CICS-maintained, user-maintained, or CF-maintained table. Valid values are:

        • CICSTABLE
        • USERTABLE
        • CFTABLE
        • NOTTABLE

        To change the Table Type attribute requires that the file be in a CLOSED state, with an ENABLESTATUS of either DISABLED or UNENABLED, and they do not take effect until the file is next opened

      • getVSAMType

        IDataTable.VSAMTypeValue getVSAMType()
        Getter for field VSAMTYPE

        Type of VSAM data set

        The type of data set associated with this data table file as one of the following options:

        • ESDS - VSAM entry-sequenced data set
        • KSDS - VSAM key-sequenced data set
        • RRDS - VSAM relative record data set
        • VRRDS - Variable relative record data set

        A value of NOTAPPLIC is returned if the data table file is not open.

      • getUpdate

        IDataTable.UpdateValue getUpdate()
        Getter for field UPDATE

        Update option

        Indicates whether records in the data table file can be updated.

        Input Values: UPDATABLE, NOTUPDATABLE

      • getOpenTime

        java.lang.String getOpenTime()
        Getter for field TIMEOPEN

        Local time file was opened

        The local time at which the data table file was opened

      • getCloseTime

        java.lang.String getCloseTime()
        Getter for field TIMECLOSE

        Local time file was closed

        The local time at which the data table file was closed

      • getReadCount

        java.lang.Long getReadCount()
        Getter for field GETCNT

        Number of READ requests

        The number of GET requests issued against this data table file

      • getReadUpdateCount

        java.lang.Long getReadUpdateCount()
        Getter for field GETUPDCNT

        Number of READ UPDATE requests

        The number of GET UPDATE requests issued against this data table file

      • getBrowseCount

        java.lang.Long getBrowseCount()
        Getter for field BROWSECNT

        Number of READNEXT and READPREV requests

        The number of GET NEXT and GET PREV requests issued against this data table file

      • getAddCount

        java.lang.Long getAddCount()
        Getter for field ADDCNT

        Number of WRITE requests

        The number of PUT requests issued against this data table file

      • getUpdateCount

        java.lang.Long getUpdateCount()
        Getter for field UPDATECNT

        Number of REWRITE requests

        The number of PUT UPDATE requests issued against this data table file

      • getDeleteCount

        java.lang.Long getDeleteCount()
        Getter for field LOCDELCNT

        Number of DELETE requests

        The number of DELETE requests issued against this data table file

      • getDataOperationCount

        java.lang.Long getDataOperationCount()
        Getter for field DEXCPCNT

        Number of I/O operations on data component

        The number of I/O operations on the data table file for data records

      • getIndexOperationCount

        java.lang.Long getIndexOperationCount()
        Getter for field IEXCPCNT

        Number of I/O operations on index component

        The number of I/O operations on the data table file for index records.

      • getTotalRequestsQueuedStringsInUseCount

        java.lang.Long getTotalRequestsQueuedStringsInUseCount()
        Getter for field WSTRCNT

        Total requests queued because strings in use

        The total number of requests queued because strings are in use

      • getReadSuccessCount

        java.lang.Long getReadSuccessCount()
        Getter for field READS

        Number of successful READs

        The number of attempts to retrieve records from the data table file that were successful

      • getRecordNotFoundCount

        java.lang.Long getRecordNotFoundCount()
        Getter for field RECNOTFND

        Total number of records not found in table

        The number of times API READ requests were directed to the source data set because the record was not found in the data table file.

      • getAddReadRecCount

        java.lang.Long getAddReadRecCount()
        Getter for field ADDFRREAD

        Number of records added to table by READ requests

        The number of records placed in the data table file by the loading process or as a result of API READ requests issued while loading was in progress

      • getAddWriteRecCount

        java.lang.Long getAddWriteRecCount()
        Getter for field ADDREQ

        Number of records added from WRITE requests

        The number of attempts to add records to the data table file as a result of API WRITE requests

      • getAddRejectUserExitCount

        java.lang.Long getAddRejectUserExitCount()
        Getter for field ADDREJ

        Number of add requests rejected by user exit

        The number of records CICS attempted to add to the data table file that were rejected by the global user exit

      • getAddRejectTabFullCount

        java.lang.Long getAddRejectTabFullCount()
        Getter for field ADDTFULL

        Number of add requests rejected when table full

        The number of records CICS attempted to add to the data table file that were rejected because the table already contained the maximum allowable number of records

      • getRewriteCount

        java.lang.Long getRewriteCount()
        Getter for field REWRITE

        Number of REWRITE requests

        The number of attempts to update records in the data table file as a result of REWRITE requests

      • getDeleteRequestCount

        java.lang.Long getDeleteRequestCount()
        Getter for field DELETEREQ

        Number of DELETE requests

        The number of attempts to delete records from the data table file as a result of DELETE requests

      • getMaxTableSize

        java.lang.Long getMaxTableSize()
        Getter for field MAXTSIZE

        Maximum table size

        The highest number of records in the data table file at any one time

      • getRecordCount

        java.lang.Long getRecordCount()
        Getter for field CURCOUNT

        Current number of records in data table file

        The current number of records in the data table file

      • getReadRetryCount

        java.lang.Long getReadRetryCount()
        Getter for field READRETRY

        Number of READ retries

        The number of times READs in an AOR had to be retried because the FOR changed the table during the read

      • getStorageAllocated

        java.lang.Long getStorageAllocated()
        Getter for field STGALCTOT

        Total storage allocated (kilobytes)

        The total amount of storage allocated to the data table file in kilobytes

      • getStorageUsed

        java.lang.Long getStorageUsed()
        Getter for field STGALCINU

        Total storage in use (kilobytes)

        The amount of storage in use for the data table file in kilobytes

      • getRecordEntryBlockStorageAllocated

        java.lang.Long getRecordEntryBlockStorageAllocated()
        Getter for field STGENTTOT

        Storage allocated for record entry blocks (KB)

        The total amount of storage allocated for the data table file's record entry blocks in kilobytes

      • getRecordEntryBlockStorageUsed

        java.lang.Long getRecordEntryBlockStorageUsed()
        Getter for field STGENTINU

        Storage in use for record entry blocks (KB)

        The amount of storage in use for the data table file's record entry blocks in kilobytes

      • getIndexStorageAllocated

        java.lang.Long getIndexStorageAllocated()
        Getter for field STGIDXTOT

        Storage allocated for index (kilobytes)

        The total amount of storage allocated for the data table file index in kilobytes

      • getIndexStorageUsed

        java.lang.Long getIndexStorageUsed()
        Getter for field STGIDXINU

        Storage in use for index (kilobytes)

        The amount of storage in use for the data table file index in kilobytes

      • getRecordStorageAllocated

        java.lang.Long getRecordStorageAllocated()
        Getter for field STGDTATOT

        Storage allocated for record data (kilobytes)

        The total amount of storage allocated for the data table file's record data in kilobytes

      • getRecordStorageUsed

        java.lang.Long getRecordStorageUsed()
        Getter for field STGDTAINU

        Storage in use for record data (kilobytes)

        The amount of storage in use for the data table file's record data in kilobytes

      • getJournalID

        java.lang.Long getJournalID()
        Getter for field JOURNALNUM

        Journal number

        The identifier of the journal associated with this data table file. An ID of 1 identifies the CICS system log. A value of 0 means there is no journal associated with this data table file

      • getPeakRequestsQueuedCount

        java.lang.Long getPeakRequestsQueuedCount()
        Getter for field WSTRCCURCNT

        Peak concurrent requests queued - strings in use

        The peak number of concurrent requests queued - strings in use

      • getLsrpoolid

        java.lang.Long getLsrpoolid()
        Getter for field LSRPOOLID

        LSR Pool number

        The identifier of the local shared resources (LSR) pool associated with this data table file.

        Input Values: 1 - 255

      • getDataBufferCount

        java.lang.Long getDataBufferCount()
        Getter for field NUMDATBUFF

        Number of data buffers

        The number of storage buffers allocated for data.

      • getIndexBufferCount

        java.lang.Long getIndexBufferCount()
        Getter for field NUMINDEXBUFF

        Number of index buffers

        The number of storage buffers allocated for the index

      • getActiveStringCount

        java.lang.Long getActiveStringCount()
        Getter for field NUMACTSTRING

        Number of active strings

        The number of currently active VSAM strings

      • getGMTOpenTime

        java.lang.String getGMTOpenTime()
        Getter for field GMTFILEOPN

        GMT file open time

        The GMT store clock time at which the data table file was opened

      • getGMTCloseTime

        java.lang.String getGMTCloseTime()
        Getter for field GMTFILECLS

        GMT file close time

        The GMT store clock time at which the data table file was closed.

      • getActiveStringWaitCount

        java.lang.Long getActiveStringWaitCount()
        Getter for field NUMSTRINGWT

        Number of active string waits

        The number of VSAM active string wait

      • getDSRecordType

        java.lang.String getDSRecordType()
        Getter for field DATASETTYPE

        Data set type

        The type of data set associated with this data table file as one of the following options:

        • B - BDAM data set
        • E - VSAM entry-sequenced data set (ESDS)
        • K - VSAM key-sequenced data set (KSDS)
        • P - VSAM path accessed by an alternate index
        • R - VSAM relative record data set (RRDS)

      • getPoolname

        java.lang.String getPoolname()
        Getter for field POOLNAME

        CFDT pool name

        For MVS Coupling Facility Data Tables, this is the name of CFDT Pool which the table is constructed in

      • getTablename

        java.lang.String getTablename()
        Getter for field TABLENAME

        CFDT table name

        For MVS Coupling Facility Data Tables, this is the name of CFDT Table which the file is loaded into

      • getUpdatemodel

        IDataTable.UpdatemodelValue getUpdatemodel()
        Getter for field UPDATEMODEL

        CFDT update model

        The type of update model that is associated with the file:

        • LOCKING - The coupling facility data table is updated using the locking model.
        • CONTENTION - The coupling facility data table is updated using the contention model.
        • NOTAPPLIC - The file does not refer to a coupling facility data table and UPDATEMODEL on the file resource definition does not specify a value. The Load specification for the data set associated with this Table (actioned by CFTABLE only):
        • NOLOAD - No data set load is required.
        • LOAD - The associated data set is to be loaded into the table when it is first opened.

      • getLoadtype

        IDataTable.LoadtypeValue getLoadtype()
        Getter for field LOADTYPE

        CFDT load type

        The Load specification for the data set associated with this Table (actioned by CFTABLE only):

        • NOLOAD - No data set load is required.
        • LOAD - The associated data set is to be loaded into the table when it is first opened
        • NOTAPPLIC - Not applicable.
      • getCFDTContentionCount

        java.lang.Long getCFDTContentionCount()
        Getter for field CONTENTION

        Number of CFDT contentions

        The number of times a read from a Data Table resulted in a contention arising on the CFDT Server

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

      • getChangeAgent

        IDataTable.ChangeAgentValue getChangeAgent()
        Getter for field CHANGEAGENT

        Last 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.
        • TABLE - The resource was last changed by a CICSPlex table definition.
        • 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.
      • 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.

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

      • getInstallAgent

        IDataTable.InstallAgentValue getInstallAgent()
        Getter for field INSTALLAGENT

        Installation 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.
        • TABLE - The resource was last installed by a CICSPlex table definition.
        • SYSTEM - The resource was last installed by the CICS system.
        • GRPLIST - The resource was installed by GRPLIST INSTALL.
      • getBasdefinever

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

        BAS resource definition version

        The BAS version number of this definition.

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