com.ibm.cics.model
Interface IPhysicalDataSet

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

public interface IPhysicalDataSet
extends ICICSResource

generated from CICS resourcetable DSNAME


Nested Class Summary
static class IPhysicalDataSet.AccessmethodValue
          Enumeration type for field ACCESSMETHOD
static class IPhysicalDataSet.AvailabilityValue
          Enumeration type for field AVAILABILITY
static class IPhysicalDataSet.BackuptypeValue
          Enumeration type for field BACKUPTYPE
static class IPhysicalDataSet.LostlocksValue
          Enumeration type for field LOSTLOCKS
static class IPhysicalDataSet.ObjectValue
          Enumeration type for field OBJECT
static class IPhysicalDataSet.QuiescestateValue
          Enumeration type for field QUIESCESTATE
static class IPhysicalDataSet.RecovstatusValue
          Enumeration type for field RECOVSTATUS
static class IPhysicalDataSet.RetlocksValue
          Enumeration type for field RETLOCKS
static class IPhysicalDataSet.ValidityValue
          Enumeration type for field VALIDITY
 
Method Summary
 IPhysicalDataSet.AccessmethodValue getAccessmethod()
          Getter for field ACCESSMETHOD
 IPhysicalDataSet.AvailabilityValue getAvailability()
          Getter for field AVAILABILITY
 IPhysicalDataSet.BackuptypeValue getBackuptype()
          Getter for field BACKUPTYPE
 java.lang.String getBasedsname()
          Getter for field BASEDSNAME
 java.lang.String getDsname()
          Getter for field DSNAME
 java.lang.Long getFilecount()
          Getter for field FILECOUNT
 java.lang.Long getFwdrecovlog()
          Getter for field FWDRECOVLOG
 java.lang.String getFwdrecovlsn()
          Getter for field FWDRECOVLSN
 IPhysicalDataSet.LostlocksValue getLostlocks()
          Getter for field LOSTLOCKS
 IPhysicalDataSet.ObjectValue getObject()
          Getter for field OBJECT
 IPhysicalDataSet.QuiescestateValue getQuiescestate()
          Getter for field QUIESCESTATE
 IPhysicalDataSet.RecovstatusValue getRecovstatus()
          Getter for field RECOVSTATUS
 IPhysicalDataSet.RetlocksValue getRetlocks()
          Getter for field RETLOCKS
 IPhysicalDataSet.ValidityValue getValidity()
          Getter for field VALIDITY
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName, getObjectType
 

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:


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.


getObject

IPhysicalDataSet.ObjectValue getObject()
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.


getRecovstatus

IPhysicalDataSet.RecovstatusValue getRecovstatus()
Getter for field RECOVSTATUS

Recovery status

Indicates the recovery characteristics of the data set as follows:


getValidity

IPhysicalDataSet.ValidityValue getValidity()
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.


getFwdrecovlog

java.lang.Long getFwdrecovlog()
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.


getFwdrecovlsn

java.lang.String getFwdrecovlsn()
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


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:


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:


getRetlocks

IPhysicalDataSet.RetlocksValue getRetlocks()
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.



Copyright 2008-2009 IBM Corp. All Rights Reserved.