Package com.compuware.api.topaz.hostresources.zos

Interface IDataSetCharacteristics

  • All Known Subinterfaces:
    IPartitionedDataSetCharacteristics, ISequentialDataSetCharacteristics, IVSAMClusterCharacteristics
    public interface IDataSetCharacteristics
    z/OS dataset characteristics.

    The state of this dataset characteristics is a snapshot of these characteristics from the time they were retrieved from the dataset. In order to retrieve the current state of these characteristics, they will need to be re-retrieved from the data set.

    Examples:
    To retrieve dataset characteristics: 

     IDataSet dataSet = ...
 
 try {
     // fetch the characteristics from the dataset
     IDataSetCharacteristics dataSetCharacteristics = dataSet
             .fetchCharacteristics();
 
     ...
 } catch (DataSetAccessException e) {
     // the user does not have access to this dataset
     ...
 } catch (DataSetInUseException e) {
     // the dataset is enqueued by another user or job
     ...
 } catch (DataSetMigratedException e) {
     // the dataset has been migrated since it was first retrieved
     ...
 } catch (DataSetNotFoundException e) {
     // the dataset can no longer be found
     ...
 }
    (Note: the above catch blocks can be replaced with a single catch block on HostResourceException.)

    For examples on how to retrieve specific subclasses of IDataSetCharacteristics see IPartitionedDataSetCharacteristics, ISequentialDataSetCharacteristics, and IVSAMClusterCharacteristics.
    For examples of how to retrieve generic IDataSets see IDataSet.
    For examples on how to retrieve specific subclasses of IDataSet see IPartitionedDataSet, ISequentialDataSet, IVSAMCluster, and IMigratedDataSet.

    Since:
    1.0.0
    Version:
    2.0.0
    See Also:
    IDataSet.fetchCharacteristics()
    Restriction:
    This interface is not intended to be extended by clients.
    Restriction:
    This interface is not intended to be implemented by clients.

    • Method Detail

      • getDataSet

        IDataSet getDataSet()
        Returns the associated dataset.
        Returns:
        the dataset
        Since:
        1.0.0

      • getDataSetName

        String getDataSetName()
        Returns the name of the associated dataset.
        Returns:
        the dataset name
        Since:
        1.0.0

      • getCreationDate

        Date getCreationDate()
        Returns the date on which the associated dataset was created.

        Note: Only the date portion of the Date object returned is valid. The time portion should be ignored.

        Returns:
        the creation date
        Since:
        1.0.0

      • getExpirationDate

        Date getExpirationDate()
        Returns the date on which the associated dataset is due to expire.

        Note: Only the date portion of the Date object returned is valid. The time portion should be ignored.

        Returns:
        the expiration date
        Since:
        1.0.0

      • getManagementClass

        String getManagementClass()
        Returns the management class of the associated dataset.
        Returns:
        the management class
        Since:
        1.0.0

      • getStorageClass

        String getStorageClass()
        Returns the storage class of the associated dataset.
        Returns:
        the storage class
        Since:
        1.0.0