IMigratedDataSet

All Superinterfaces:

IDataSet, IHostResource
```
public interface IMigratedDataSet
extends IDataSet
```
A migrated dataset that resides on a z/OS host.
For details on the state of an IMigratedDataSet and the function of its methods, see IHostResource.
Examples:
To retrieve a migrated dataset:
```
 IDataSetCommandProvider commandProvider = ...
 String dataSetName = ...
 
 // dataSet will be null if it cannot be found
 IMigratedDataSet dataSet = commandProvider
         .findMigratedDataSet(dataSetName);
 
```
To retrieve a list of migrated datasets matching a filter:
```
 IDataSetCommandProvider commandProvider = ...
 String dataSetFilter = ...
 
 // dataSets will be empty if no migrated datasets match the dataset
 // filter
 List<IMigratedDataSet> dataSets = commandProvider
         .findMigratedDataSets(dataSetFilter);
 
```
For examples on how to obtain an IDataSetCommandProvider see IDataSetCommandProvider.
For examples of how to retrieve generic IDataSets see IDataSet.
Since:

1.0.0

Version:

2.0.0

Restriction:

This interface is not intended to be extended by clients.

Restriction:

This interface is not intended to be implemented by clients.

- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  IDataSet recall()
  Recalls this migrated dataset.
  - Methods inherited from interface com.compuware.api.topaz.hostresources.zos.IDataSet
    delete, fetchCharacteristics, getHostConnection, getType, isAlias
  - Methods inherited from interface com.compuware.api.topaz.hostresources.IHostResource
    getName

- Method Detail
  - recall
```
IDataSet recall()
         throws DataSetNotFoundException
```
    Recalls this migrated dataset.
    The method blocks until the recall is completed, or an exception occurs. The recall processing cannot be cancelled.
    If the dataset is no longer migrated when this method is called, the previously recalled dataset will be returned.
    
    Returns:
    
    the recalled dataset
    
    Throws:
    
    ZOSSystemException - if a z/OS system error occurs
    
    ZOSAbendException - if a z/OS ABEND occurs
    
    DataSetNotFoundException - if this migrated dataset no longer exists
    
    Since:
    
    1.0.0