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.DataSetTypeValue
          Enumeration type for field OBJECT
static class IPhysicalDataSet.DataSetValidityValue
          Enumeration type for field VALIDITY
static class IPhysicalDataSet.LostLocksValue
          Enumeration type for field LOSTLOCKS
static class IPhysicalDataSet.QuiesceStateValue
          Enumeration type for field QUIESCESTATE
static class IPhysicalDataSet.RecoveryStatusValue
          Enumeration type for field RECOVSTATUS
static class IPhysicalDataSet.ReplicationLoggingStatusValue
          Enumeration type for field LOGREPSTATUS
static class IPhysicalDataSet.RetainedRecordLocksValue
          Enumeration type for field RETLOCKS
 
Field Summary
 
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,IPhysicalDataSet> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 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
 IPhysicalDataSetReference getCICSObjectReference()
           
 IPhysicalDataSet.DataSetTypeValue getDataSetType()
          Getter for field OBJECT
 IPhysicalDataSet.DataSetValidityValue getDataSetValidity()
          Getter for field VALIDITY
 java.lang.String getDsname()
          Getter for field DSNAME
 java.lang.Long getFileCount()
          Getter for field FILECOUNT
 java.lang.Long getJournalNumber()
          Getter for field FWDRECOVLOG
 java.lang.String getLogStreamName()
          Getter for field FWDRECOVLSN
 IPhysicalDataSet.LostLocksValue getLostLocks()
          Getter for field LOSTLOCKS
 ICICSType<IPhysicalDataSet> getObjectType()
           
 IPhysicalDataSet.QuiesceStateValue getQuiesceState()
          Getter for field QUIESCESTATE
 IPhysicalDataSet.RecoveryStatusValue getRecoveryStatus()
          Getter for field RECOVSTATUS
 IPhysicalDataSet.ReplicationLoggingStatusValue getReplicationLoggingStatus()
          Getter for field LOGREPSTATUS
 IPhysicalDataSet.RetainedRecordLocksValue getRetainedRecordLocks()
          Getter for field RETLOCKS
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
 
Methods inherited from interface com.ibm.cics.model.meta.ITypedObject
getAttributeValue
 

Method Detail

getObjectType

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

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.


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:


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


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:


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


getCICSObjectReference

IPhysicalDataSetReference getCICSObjectReference()
Specified by:
getCICSObjectReference in interface ICICSObject

findReferences

<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,IPhysicalDataSet> 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.