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

Interface ISequentialDataSetCharacteristics

  • All Superinterfaces:
    IDataSetCharacteristics
    public interface ISequentialDataSetCharacteristics
extends IDataSetCharacteristics
    Sequential dataset characteristics.

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

    Examples:
    To retrieve sequential dataset characteristics: 

     ISequentialDataSet sequentialDataSet = ...
 
 try {
     // fetch the sequential dataset characteristics from the sequential
     // dataset
     ISequentialDataSetCharacteristics sequentialDataSetCharacteristics = sequentialDataSet
             .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 generic IDataSetCharacteristics see IDataSetCharacteristics.
    For examples of how to retrieve ISequentialDataSets see ISequentialDataSet.

    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 Detail

      • getExtentsAllocated

        int getExtentsAllocated()
        Returns the number of extents allocated to the associated sequential dataset.
        Returns:
        the number of extents allocated
        Since:
        1.0.0

      • getPrimaryUnitsAllocated

        int getPrimaryUnitsAllocated()
        Returns the number of primary (first extent) units that are allocated to the associated sequential dataset.
        Returns:
        the number of primary units allocated
        Since:
        1.0.0

      • getSecondaryUnitsAllocated

        int getSecondaryUnitsAllocated()
        Returns the number of secondary units that are allocated to the associated sequential dataset.
        Returns:
        the number of secondary units allocated
        Since:
        1.0.0

      • getUnitsAllocated

        int getUnitsAllocated()
        Returns the total number of units (primary and secondary) that are allocated to the associated sequential dataset.
        Returns:
        the number of units allocated
        Since:
        1.0.0

      • getAllocationUnit

        AllocationUnit getAllocationUnit()
        Returns the allocation unit of the associated sequential dataset.
        Returns:
        the allocation unit
        Since:
        1.0.0

      • getBlockSize

        int getBlockSize()
        Returns the block size of the associated sequential dataset.
        Returns:
        the block size
        Since:
        1.0.0

      • getDataSetOrganization

        DataSetOrganization getDataSetOrganization()
        Returns the organization of the associated sequential dataset.
        Returns:
        the dataset organization
        Since:
        1.0.0

      • getDeviceType

        DeviceType getDeviceType()
        Returns the type of the device on which the associated sequential dataset resides.
        Returns:
        the device type
        Since:
        1.0.0

      • getLastUsedTTR

        String getLastUsedTTR()
        Returns the last used relative track address (TTR) in the associated sequential dataset.

        An empty string will be returned if there is no last used TTR.

        Returns:
        the last used TTR or an empty String
        Since:
        1.0.0

      • getLogicalRecordLength

        int getLogicalRecordLength()
        Returns the logical record length of the associated sequential dataset.
        Returns:
        the logical record length
        Since:
        1.0.0

      • getRecordFormat

        RecordFormat getRecordFormat()
        Returns the record format of the associated sequential dataset.
        Returns:
        the record format
        Since:
        1.0.0

      • getExtentsUsed

        int getExtentsUsed()
        Returns the total number of extents used by the associated sequential dataset.
        Returns:
        the number of extents used
        Since:
        1.0.0

      • getUnitsUsed

        int getUnitsUsed()
        Returns the total number of units used by the associated sequential dataset.
        Returns:
        the number of units used
        Since:
        1.0.0

      • getVolume

        String getVolume()
        Returns the volume on which the associated sequential dataset resides.
        Returns:
        the volume
        Since:
        1.0.0