com.ibm.ftt.resources.zos.zosphysical
Interface ZOSDataSet

All Superinterfaces:
Comparable, IAdaptable, IPhysicalResource, ZOSResource
All Known Subinterfaces:
ZOSGenerationDataGroup, ZOSPartitionedDataSet, ZOSSequentialDataSet, ZOSVsamDataSet

public interface ZOSDataSet
extends ZOSResource, Comparable

The ZOSDataSet represents a data set in a z/OS system. Migrated and offline (volume) data set are represented as instances of ZOSDataSet. Partitioned, sequential and VSAM data sets are represented as instances of specializations of ZOSDataSet.


Field Summary
static String COPY_RIGHT
           
 
Method Summary
 void allocate(IProgressMonitor monitor)
          Allocates a new data set.
 void allocateLike(IProgressMonitor monitor, String likeDataSetName)
          Allocates a new data set using characteristics of the data set specified by likeDataSetName.
 ZOSCatalog getCatalog()
          Returns the catalog containing this data set.
 DataSetCharacteristics getCharacteristics()
          Returns characteristics of this data set.
 ZOSGenerationDataGroup getGenerationDataGroup()
          Returns a generation data group if this is a generation data set, or null
 String getReference()
          Returns the name of the data set for which this resource is an alias if this is a data set alias.
 String getRelativeGenerationNumber()
          Get relative generation number
 void hdelete(boolean force, IProgressMonitor monitor)
          Deletes a migrated data set.
 boolean isAlias()
          Determines whether this data set is an alias or not.
 boolean isMigrated()
          Determines whether this data set is migrated or not.
 boolean isOfflineVolume()
          Determines whether this data set is on an offline volume.
 void migrate(boolean wait, IProgressMonitor monitor)
          Migrates this data set.
 void recall(boolean wait, IProgressMonitor monitor)
          Recalls a migrated data set.
 void setCharacteristics(DataSetCharacteristics value)
          Sets characteristics of this data set.
 void setGenerationDataGroup(ZOSGenerationDataGroup gdg)
          Set generation data group
 
Methods inherited from interface com.ibm.ftt.resources.zos.zosphysical.ZOSResource
copy, getCharset, getMVSFileMapping, getMVSFileMappingOverride, getName, getResourceIdentifier, setMVSFileMappingOverride
 
Methods inherited from interface com.ibm.ftt.resources.core.physical.IPhysicalResource
delete, deleteOverriddenPropertiesInCategory, deleteOverride, exists, getCurrentPropertyGroup, getFullPath, getModificationStamp, getModificationStamp, getOverriddenProperties, getParent, getPersistentProperty, getResourcePublisher, getSessionProperty, refresh, rename, setCurrentPropertyGroup, setOverride, setPersistentProperty, setSessionProperty
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

COPY_RIGHT

static final String COPY_RIGHT
See Also:
Constant Field Values
Method Detail

getCatalog

ZOSCatalog getCatalog()
Returns the catalog containing this data set.

Returns:
the catalog object

getCharacteristics

DataSetCharacteristics getCharacteristics()
Returns characteristics of this data set.

Returns:
the the data set characteristics object that contains various characteristics information such as volume serial, space units, etc.
See Also:
ZOSDataSet.setCharacteristics(DataSetCharacteristics)

setCharacteristics

void setCharacteristics(DataSetCharacteristics value)
Sets characteristics of this data set.

Parameters:
value - a data set characteristics object to set
See Also:
ZOSDataSet.getCharacteristics()

allocate

void allocate(IProgressMonitor monitor)
              throws OperationFailedException
Allocates a new data set.

To allocate a data set, create a data set model object using IPhysicalResourceFactory, set the DataSetCharacteristics of the model object, and then call this method. For example,

 ZOSDataSet res = (ZOSDataSet)physicalFactory.getPhysicalResource(
                                                catalog,
                                                ZOSPartitionedDataSet.class,
                                                datasetName);
 res.setCharacteristics(characteristics);
 res.allocate(monitor);
 

Parameters:
monitor - a progress monitor to indicate the progress, or null if progress reporting is not desired
Throws:
OperationFailedException - if allocate operation failed
See Also:
ZOSDataSet.allocateLike(IProgressMonitor, String)

allocateLike

void allocateLike(IProgressMonitor monitor,
                  String likeDataSetName)
                  throws OperationFailedException
Allocates a new data set using characteristics of the data set specified by likeDataSetName. The data set specified by likeDataSetName is assumed to reside on the same system as this model object.

Parameters:
monitor - a progress monitor to indicate the progress, or null if progress reporting is not desired
likeDataSetName - fully qualified name of the data set whose characteristics need to be used for allocation; or null to use the characteristics set to this data set
Throws:
OperationFailedException - if allocate operation failed
See Also:
ZOSDataSet.allocate(IProgressMonitor)

recall

void recall(boolean wait,
            IProgressMonitor monitor)
            throws OperationFailedException
Recalls a migrated data set. Performs HRECALL operation.

Parameters:
wait - currently not used
monitor - a progress monitor to indicate the progress, or null if progress reporting is not desired
Throws:
OperationFailedException - if recall operation failed
See Also:
ZOSDataSet.isMigrated(), ZOSDataSet.migrate(boolean, IProgressMonitor), ZOSDataSet.hdelete(boolean, IProgressMonitor)

migrate

void migrate(boolean wait,
             IProgressMonitor monitor)
             throws OperationFailedException
Migrates this data set.

Parameters:
wait - currently not used
monitor - a progress monitor to indicate the progress, or null if progress reporting is not desired
Throws:
OperationFailedException - if recall operation failed
See Also:
ZOSDataSet.isMigrated(), ZOSDataSet.recall(boolean, IProgressMonitor), ZOSDataSet.hdelete(boolean, IProgressMonitor)

isMigrated

boolean isMigrated()
Determines whether this data set is migrated or not.

Returns:
true if this data set is migrated; false otherwise
See Also:
ZOSDataSet.migrate(boolean, IProgressMonitor), ZOSDataSet.recall(boolean, IProgressMonitor), ZOSDataSet.hdelete(boolean, IProgressMonitor)

hdelete

void hdelete(boolean force,
             IProgressMonitor monitor)
             throws OperationFailedException
Deletes a migrated data set. Performs HDELETE operation.

Parameters:
force - currently not used
monitor - a progress monitor to indicate the progress, or null if progress reporting is not desired
Throws:
OperationFailedException - if HDELETE operation failed
See Also:
ZOSDataSet.isMigrated(), ZOSDataSet.migrate(boolean, IProgressMonitor), ZOSDataSet.recall(boolean, IProgressMonitor)

isOfflineVolume

boolean isOfflineVolume()
Determines whether this data set is on an offline volume.

Returns:
true if this data set is on an offline volume; false otherwise

isAlias

boolean isAlias()
Determines whether this data set is an alias or not.

Returns:
true if the data set is an alias; false otherwise

getReference

String getReference()
Returns the name of the data set for which this resource is an alias if this is a data set alias.

Returns:
name of the referenced data set. Returns an empty string if this is not an alias

getGenerationDataGroup

ZOSGenerationDataGroup getGenerationDataGroup()
Returns a generation data group if this is a generation data set, or null

Returns:
generation data group

setGenerationDataGroup

void setGenerationDataGroup(ZOSGenerationDataGroup gdg)
Set generation data group

Parameters:
gdg - generation data group

getRelativeGenerationNumber

String getRelativeGenerationNumber()
Get relative generation number

Returns:
relative generation number