Interface IPhysicalDataSet

    • Method Detail

      • getDsname

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

        Data set name

        The name of the data set.

      • getAccessMethod

        IPhysicalDataSet.AccessMethodValue getAccessMethod()
        Getter for field ACCESSMETHOD

        Access method

        The access method used with this data set: BDAM, VSAM, or NOTAPPLIC.

      • getBackUpType

        IPhysicalDataSet.BackUpTypeValue getBackUpType()
        Getter for field BACKUPTYPE

        Type of backup

        Indicates the type of backup used for this data set. Values are:

        • DYNAMIC - The data set is eligible for 'backup-while-open' (BWO) processing; that is, a data set manager with the required function can take a backup of the data set while it is open for output. The data set can also be backed up while it is closed. The data set is eligible for BWO and it is accessed in non-RLS mode. If the data set is opened in RLS mode, you need to look in the VSAM catalog to find out whether the data set is eligible for BWO. NOTAPPLIC is returned as the BACKUPTYPE for data sets opened RLS mode.
        • NOTAPPLIC - The data set has not been opened by the CICS region in which the command is issued, or the data set is BDAM or a VSAM PATH. Also, if the data set has been opened in RLS mode, NOTAPPLIC is returned. The VSAM catalog should be referred to get the BWO status.
        • STATIC - The data set is accessed in non-RLS mode, and is not eligible for BWO processing. All CICS files open for output against this data set must be closed before a data set manager, can take a backup copy.
        • UNDETERMINED - Returned for base files if RECOVSTATUS is UNDETERMINED.
      • getBaseDSName

        java.lang.String getBaseDSName()
        Getter for field BASEDSNAME

        Base data set name

        For a VSAM path, the name of the base data set with which the path is associated. For a VSAM base data set, this name is the same as the primary data set name.

      • getFileCount

        java.lang.Long getFileCount()
        Getter for field FILECOUNT

        Number of file definitions that reference data set

        The number of different file definitions that currently refer to this data set name. This value does not indicate whether any of the files have used the data set during this CICS session.

      • getDataSetType

        IPhysicalDataSet.DataSetTypeValue getDataSetType()
        Getter for field OBJECT

        Data set type

        For VSAM data sets, indicates whether this data set is a base data set containing records (BASE), a path to another data set (PATH), or (NOTAPPLIC) if the dataset has not been opened by this CICS region, or if it is a BDAM dataset.

      • getRecoveryStatus

        IPhysicalDataSet.RecoveryStatusValue getRecoveryStatus()
        Getter for field RECOVSTATUS

        Recovery status

        Indicates the recovery characteristics of the data set as follows:

        • FWDRECOVABLE - All updates to the data set are logged for both backout and forward recovery
        • NOTAPPLIC - This is a BDAM data set or a VSAM path, or the data set has not been opened by the CICS region in which the command is issued.
        • NOTRECOVABLE - Updates to the data set are not logged.
        • RECOVERABLE - All updates to the data set are logged for backout.
        • UNDETERMINED - The recovery status is unknown because no files associated with this data set have been opened, or because the only files opened were defined as coupling facility data tables or as user-maintained data tables (where the recovery attributes are independent of the associated data set).
      • getDataSetValidity

        IPhysicalDataSet.DataSetValidityValue getDataSetValidity()
        Getter for field VALIDITY

        Data set validity status

        For VSAM data sets, indicates whether the data set name has been validated against the VSAM catalog by opening a file against that data set (VALID or INVALID). If this value is INVALID, the recovery status of the data set cannot be determined.

      • getJournalNumber

        java.lang.Long getJournalNumber()
        Getter for field FWDRECOVLOG

        Journal number

        For VSAM data sets with a recovery status of FWDRECOVABLE, the ID of the journal that is used to log updates.

      • getLogStreamName

        java.lang.String getLogStreamName()
        Getter for field FWDRECOVLSN

        Forward recovery log stream name

        For VSAM data sets with a recovery status of FWDRECOVABLE, the ID of the journal that is used to log updates.

      • getAvailability

        IPhysicalDataSet.AvailabilityValue getAvailability()
        Getter for field AVAILABILITY

        Availability status

        For VSAM data sets, indicates whether or not the data set is available.

        Input Values: AVAILABLE, UNAVAILABLE, RREPL

      • getLostLocks

        IPhysicalDataSet.LostLocksValue getLostLocks()
        Getter for field LOSTLOCKS

        Lost locks status

        Indicates whether there are lost locks for this data set. The valid values are:

        • NOLOSTLOCKS - The data set has no lost locks.
        • REMLOSTLOCKS - .The data set has lost locks.
        • RECOVERLOCKS - The data set has lost locks and therefore is unavailable.
        • NOTAPPLIC - This is not an RLS data set, or the data set has not been opened by the CICS region in which the command is issued.
      • getQuiesceState

        IPhysicalDataSet.QuiesceStateValue getQuiesceState()
        Getter for field QUIESCESTATE

        Record level sharing (RLS) quiesce state

        The RLS quiesce state of the data set. The information is obtained from the ICF catalog entry for the data set. Valid input values are:

        • Quiesced - A data set has been quiesced. RLS ACBs cannot open against the data set and no CICS region has an RLS ACB currently open against this data set. However, the data set can be opened in non-RLS mode.
        • Unquiesced - This is the normal value for a data set that is not quiescing or has not been quiesced. It indicates that RLS or non-RLS ACBs can be opened against the data set, the mode being established by the first open. After an ACB is opened in one mode, other ACBs can be opened only in the same mode.
      • getRetainedRecordLocks

        IPhysicalDataSet.RetainedRecordLocksValue getRetainedRecordLocks()
        Getter for field RETLOCKS

        Retained record locks status

        Indicates whether or not there are any retained locks as a result of deferred recovery work for this data set. Valid values are: RETAINED, NORETAINED and NOTAPPLIC.

      • getReplicationLoggingStatus

        IPhysicalDataSet.ReplicationLoggingStatusValue getReplicationLoggingStatus()
        Getter for field LOGREPSTATUS

        Replication Logging

        For VSAM data sets, indicates whether this data set has been defined to have replication logging. Valid values are: LOGREPLICATE, NOLOGREPLICA, NOTAPPLIC