com.ibm.cics.model
Interface IDataTable

All Superinterfaces:
ICICSObject, ICICSResource, IInstalledCICSResource, com.ibm.cics.model.meta.ITypedObject

public interface IDataTable
extends ICICSResource, IInstalledCICSResource

generated from CICS resourcetable CMDT


Nested Class Summary
static class IDataTable.AddValue
          Enumeration type for field ADD
static class IDataTable.BrowseValue
          Enumeration type for field BROWSE
static class IDataTable.ChangeAgentValue
          Enumeration type for field CHANGEAGENT
static class IDataTable.DeleteValue
          Enumeration type for field DELETE
static class IDataTable.DispositionValue
          Enumeration type for field DISPOSITION
static class IDataTable.ForwardRecoveryStatusValue
          Enumeration type for field FWDRECSTATUS
static class IDataTable.InstallAgentValue
          Enumeration type for field INSTALLAGENT
static class IDataTable.LoadtypeValue
          Enumeration type for field LOADTYPE
static class IDataTable.OpenstatusValue
          Enumeration type for field OPENSTATUS
static class IDataTable.ReadValue
          Enumeration type for field READ
static class IDataTable.RecordFormatValue
          Enumeration type for field RECORDFORMAT
static class IDataTable.RecovstatusValue
          Enumeration type for field RECOVSTATUS
static class IDataTable.StatusValue
          Enumeration type for field ENABLESTATUS
static class IDataTable.TableValue
          Enumeration type for field TABLE
static class IDataTable.UpdatemodelValue
          Enumeration type for field UPDATEMODEL
static class IDataTable.UpdateValue
          Enumeration type for field UPDATE
static class IDataTable.VSAMTypeValue
          Enumeration type for field VSAMTYPE
 
Field Summary
 
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
 
Fields inherited from interface com.ibm.cics.model.IInstalledCICSResource
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,IDataTable> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 java.lang.Long getActiveStringCount()
          Getter for field NUMACTSTRING
 java.lang.Long getActiveStringWaitCount()
          Getter for field NUMSTRINGWT
 IDataTable.AddValue getAdd()
          Getter for field ADD
 java.lang.Long getAddCount()
          Getter for field ADDCNT
 java.lang.Long getAddReadRecCount()
          Getter for field ADDFRREAD
 java.lang.Long getAddRejectTabFullCount()
          Getter for field ADDTFULL
 java.lang.Long getAddRejectUserExitCount()
          Getter for field ADDREJ
 java.lang.Long getAddWriteRecCount()
          Getter for field ADDREQ
 java.lang.Long getBasdefinever()
          Getter for field BASDEFINEVER
 IDataTable.BrowseValue getBrowse()
          Getter for field BROWSE
 java.lang.Long getBrowseCount()
          Getter for field BROWSECNT
 java.lang.Long getCFDTContentionCount()
          Getter for field CONTENTION
 IDataTable.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
 IDataTableReference getCICSObjectReference()
           
 java.lang.String getCloseTime()
          Getter for field TIMECLOSE
 java.lang.Long getDataBufferCount()
          Getter for field NUMDATBUFF
 java.lang.Long getDataOperationCount()
          Getter for field DEXCPCNT
 java.lang.String getDefineSource()
          Getter for field DEFINESOURCE
 java.util.Date getDefineTime()
          Getter for field DEFINETIME
 IDataTable.DeleteValue getDelete()
          Getter for field DELETE
 java.lang.Long getDeleteCount()
          Getter for field LOCDELCNT
 java.lang.Long getDeleteRequestCount()
          Getter for field DELETEREQ
 IDataTable.DispositionValue getDisposition()
          Getter for field DISPOSITION
 java.lang.String getDsname()
          Getter for field DSNAME
 java.lang.String getDSRecordType()
          Getter for field DATASETTYPE
 IDataTable.ForwardRecoveryStatusValue getForwardRecoveryStatus()
          Getter for field FWDRECSTATUS
 java.lang.String getGMTCloseTime()
          Getter for field GMTFILECLS
 java.lang.String getGMTOpenTime()
          Getter for field GMTFILEOPN
 java.lang.Long getIndexBufferCount()
          Getter for field NUMINDEXBUFF
 java.lang.Long getIndexOperationCount()
          Getter for field IEXCPCNT
 java.lang.Long getIndexStorageAllocated()
          Getter for field STGIDXTOT
 java.lang.Long getIndexStorageUsed()
          Getter for field STGIDXINU
 IDataTable.InstallAgentValue getInstallAgent()
          Getter for field INSTALLAGENT
 java.util.Date getInstallTime()
          Getter for field INSTALLTIME
 java.lang.String getInstallUserID()
          Getter for field INSTALLUSRID
 java.lang.Long getJournalID()
          Getter for field JOURNALNUM
 java.lang.Long getKeyLength()
          Getter for field KEYLENGTH
 java.lang.Long getKeyPosition()
          Getter for field KEYPOSITION
 IDataTable.LoadtypeValue getLoadtype()
          Getter for field LOADTYPE
 java.lang.Long getLsrpoolid()
          Getter for field LSRPOOLID
 java.lang.Long getMaxnumrecs()
          Getter for field MAXNUMRECS
 java.lang.Long getMaxTableSize()
          Getter for field MAXTSIZE
 java.lang.String getName()
          Getter for field FILE
 ICICSType<IDataTable> getObjectType()
           
 IDataTable.OpenstatusValue getOpenstatus()
          Getter for field OPENSTATUS
 java.lang.String getOpenTime()
          Getter for field TIMEOPEN
 java.lang.Long getPeakRequestsQueuedCount()
          Getter for field WSTRCCURCNT
 java.lang.String getPoolname()
          Getter for field POOLNAME
 IDataTable.ReadValue getRead()
          Getter for field READ
 java.lang.Long getReadCount()
          Getter for field GETCNT
 java.lang.Long getReadRetryCount()
          Getter for field READRETRY
 java.lang.Long getReadSuccessCount()
          Getter for field READS
 java.lang.Long getReadUpdateCount()
          Getter for field GETUPDCNT
 java.lang.Long getRecordCount()
          Getter for field CURCOUNT
 java.lang.Long getRecordEntryBlockStorageAllocated()
          Getter for field STGENTTOT
 java.lang.Long getRecordEntryBlockStorageUsed()
          Getter for field STGENTINU
 IDataTable.RecordFormatValue getRecordFormat()
          Getter for field RECORDFORMAT
 java.lang.Long getRecordNotFoundCount()
          Getter for field RECNOTFND
 java.lang.Long getRecordsize()
          Getter for field RECORDSIZE
 java.lang.Long getRecordStorageAllocated()
          Getter for field STGDTATOT
 java.lang.Long getRecordStorageUsed()
          Getter for field STGDTAINU
 IDataTable.RecovstatusValue getRecovstatus()
          Getter for field RECOVSTATUS
 java.lang.Long getRewriteCount()
          Getter for field REWRITE
 IDataTable.StatusValue getStatus()
          Getter for field ENABLESTATUS
 java.lang.Long getStorageAllocated()
          Getter for field STGALCTOT
 java.lang.Long getStorageUsed()
          Getter for field STGALCINU
 java.lang.Long getStrings()
          Getter for field STRINGS
 IDataTable.TableValue getTable()
          Getter for field TABLE
 java.lang.String getTablename()
          Getter for field TABLENAME
 java.lang.Long getTotalRequestsQueuedStringsInUseCount()
          Getter for field WSTRCNT
 IDataTable.UpdateValue getUpdate()
          Getter for field UPDATE
 java.lang.Long getUpdateCount()
          Getter for field UPDATECNT
 IDataTable.UpdatemodelValue getUpdatemodel()
          Getter for field UPDATEMODEL
 IDataTable.VSAMTypeValue getVSAMType()
          Getter for field VSAMTYPE
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
 
Methods inherited from interface com.ibm.cics.model.meta.ITypedObject
getAttributeValue
 

Method Detail

getObjectType

ICICSType<IDataTable> getObjectType()
Specified by:
getObjectType in interface ICICSObject
Specified by:
getObjectType in interface com.ibm.cics.model.meta.ITypedObject

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:


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:

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:

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:


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:


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


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.


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.


getBasdefinever

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

BAS resource definition version

The BAS version number of this definition.


getCICSObjectReference

IDataTableReference getCICSObjectReference()
Specified by:
getCICSObjectReference in interface ICICSObject

findReferences

<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,IDataTable> referenceAttribute)
Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute. The list factory can be activated by the caller when necessary. This method does not perform any I/O.



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