|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface ZOSDataSet
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(org.eclipse.core.runtime.IProgressMonitor monitor)
Allocates a new data set. |
void |
allocateLike(org.eclipse.core.runtime.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,
org.eclipse.core.runtime.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,
org.eclipse.core.runtime.IProgressMonitor monitor)
Migrates this data set. |
void |
recall(boolean wait,
org.eclipse.core.runtime.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 |
| Field Detail |
|---|
static final String COPY_RIGHT
| Method Detail |
|---|
ZOSCatalog getCatalog()
DataSetCharacteristics getCharacteristics()
setCharacteristics(DataSetCharacteristics)void setCharacteristics(DataSetCharacteristics value)
value - a data set characteristics object to setgetCharacteristics()
void allocate(org.eclipse.core.runtime.IProgressMonitor monitor)
throws OperationFailedException
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);
monitor - a progress monitor to indicate the progress, or
null if progress reporting is not desired
OperationFailedException - if allocate operation failedallocateLike(IProgressMonitor, String)
void allocateLike(org.eclipse.core.runtime.IProgressMonitor monitor,
String likeDataSetName)
throws OperationFailedException
likeDataSetName. The data set specified by
likeDataSetName is assumed to reside on the same system as
this model object.
monitor - a progress monitor to indicate the progress, or
null if progress reporting is not desiredlikeDataSetName - 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
OperationFailedException - if allocate operation failedallocate(IProgressMonitor)
void recall(boolean wait,
org.eclipse.core.runtime.IProgressMonitor monitor)
throws OperationFailedException
wait - currently not usedmonitor - a progress monitor to indicate the progress, or
null if progress reporting is not desired
OperationFailedException - if recall operation failedisMigrated(),
migrate(boolean, IProgressMonitor),
hdelete(boolean, IProgressMonitor)
void migrate(boolean wait,
org.eclipse.core.runtime.IProgressMonitor monitor)
throws OperationFailedException
wait - currently not usedmonitor - a progress monitor to indicate the progress, or
null if progress reporting is not desired
OperationFailedException - if recall operation failedisMigrated(),
recall(boolean, IProgressMonitor),
hdelete(boolean, IProgressMonitor)boolean isMigrated()
true if this data set is migrated;
false otherwisemigrate(boolean, IProgressMonitor),
recall(boolean, IProgressMonitor),
hdelete(boolean, IProgressMonitor)
void hdelete(boolean force,
org.eclipse.core.runtime.IProgressMonitor monitor)
throws OperationFailedException
force - currently not usedmonitor - a progress monitor to indicate the progress, or
null if progress reporting is not desired
OperationFailedException - if HDELETE operation failedisMigrated(),
migrate(boolean, IProgressMonitor),
recall(boolean, IProgressMonitor)boolean isOfflineVolume()
true if this data set is on an offline volume;
false otherwiseboolean isAlias()
true if the data set is an alias;
false otherwiseString getReference()
ZOSGenerationDataGroup getGenerationDataGroup()
void setGenerationDataGroup(ZOSGenerationDataGroup gdg)
gdg - generation data groupString getRelativeGenerationNumber()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||