All Superinterfaces:

IDataSetCharacteristics
```
public interface IPartitionedDataSetCharacteristics
extends IDataSetCharacteristics
```
Partitioned dataset (PDS) characteristics.
The state of this partitioned dataset characteristics is a snapshot of these characteristics from the time they were retrieved from the partitioned dataset. In order to retrieve the current state of these characteristics, they will need to be re-retrieved from the partitioned dataset.
Examples:
To retrieve partitioned dataset characteristics:
```
 IPartitionedDataSet dataSet = ...
 
 try {
     // fetch the partitioned dataset characteristics from the
     // partitioned dataset
     IPartitionedDataSetCharacteristics partitionedDataSetCharacteristics = partitionedDataSet
             .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 IPartitionedDataSets see IPartitionedDataSet.
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
`AllocationUnit`	`getAllocationUnit()`	Returns the allocation unit of the associated partitioned dataset.
`int`	`getBlockSize()`	Returns the block size of the associated partitioned dataset.
`IPartitionedDataSet`	`getDataSet()`	Returns the associated dataset.
`DataSetOrganization`	`getDataSetOrganization()`	Returns the organization of the associated partitioned dataset.
`DeviceType`	`getDeviceType()`	Returns the type of the device on which the associated partitioned dataset resides.
`int`	`getDirectoryBlocksUsed()`	Returns the number of directory blocks used by the associated partitioned dataset.
`int`	`getExtentsAllocated()`	Returns the number of extents allocated to the associated partitioned dataset.
`int`	`getExtentsUsed()`	Returns the total number of extents used by the associated partitioned dataset.
`String`	`getLastUsedTTR()`	Returns the last used relative track address (TTR) in the associated partitioned dataset.
`int`	`getLogicalRecordLength()`	Returns the logical record length of the associated partitioned dataset.
`int`	`getMaximumDirectoryBlocks()`	Returns the maximum number of directory blocks that the associated partitioned dataset can have.
`int`	`getMemberCount()`	Returns the number of members in the associated partitioned dataset.
`int`	`getPrimaryUnitsAllocated()`	Returns the number of primary (first extent) units that are allocated to the associated partitioned dataset.
`RecordFormat`	`getRecordFormat()`	Returns the record format of the associated partitioned dataset.
`int`	`getSecondaryUnitsAllocated()`	Returns the number of secondary units that are allocated to the associated partitioned dataset.
`int`	`getUnitsAllocated()`	Returns the total number of units (primary and secondary) that are allocated to the associated partitioned dataset.
`int`	`getUnitsUsed()`	Returns the total number of units used by the associated PDS.
`String`	`getVolume()`	Returns the volume on which the associated partitioned dataset resides.
`boolean`	`isExtended()`	Returns whether the associated partitioned dataset is extended (is a PDSE).

Methods inherited from interface com.compuware.api.topaz.hostresources.zos.IDataSetCharacteristics
getCreationDate, getDataSetName, getExpirationDate, getManagementClass, getStorageClass

- Method Detail
  - getDataSet
```
IPartitionedDataSet getDataSet()
```
    Returns the associated dataset.
    
    Specified by:
    
    getDataSet in interface IDataSetCharacteristics
    
    Returns:
    
    the partitioned dataset
    
    Since:
    
    1.0.0
  - getExtentsAllocated
```
int getExtentsAllocated()
```
    Returns the number of extents allocated to the associated partitioned 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 partitioned 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 partitioned 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 partitioned dataset.
    
    Returns:
    
    the number of units allocated
    
    Since:
    
    1.0.0
  - getAllocationUnit
```
AllocationUnit getAllocationUnit()
```
    Returns the allocation unit of the associated partitioned dataset.
    
    Returns:
    
    the allocation unit
    
    Since:
    
    1.0.0
  - getBlockSize
```
int getBlockSize()
```
    Returns the block size of the associated partitioned dataset.
    
    Returns:
    
    the block size
    
    Since:
    
    1.0.0
  - getDataSetOrganization
```
DataSetOrganization getDataSetOrganization()
```
    Returns the organization of the associated partitioned dataset.
    
    Returns:
    
    the dataset organization
    
    Since:
    
    1.0.0
  - getDeviceType
```
DeviceType getDeviceType()
```
    Returns the type of the device on which the associated partitioned dataset resides.
    
    Returns:
    
    the device type
    
    Since:
    
    1.0.0
  - getLastUsedTTR
```
String getLastUsedTTR()
```
    Returns the last used relative track address (TTR) in the associated partitioned dataset.
    An empty string will be returned if there is no last used TTR (this will always be the case for a PDSE).
    
    Returns:
    
    the last used TTR or an empty String
    
    Since:
    
    1.0.0
  - getLogicalRecordLength
```
int getLogicalRecordLength()
```
    Returns the logical record length of the associated partitioned dataset.
    
    Returns:
    
    the logical record length
    
    Since:
    
    1.0.0
  - getRecordFormat
```
RecordFormat getRecordFormat()
```
    Returns the record format of the associated partitioned dataset.
    
    Returns:
    
    the record format
    
    Since:
    
    1.0.0
  - getExtentsUsed
```
int getExtentsUsed()
```
    Returns the total number of extents used by the associated partitioned dataset.
    -1 will be returned if the associated partitioned dataset is extended (is a PDSE).
    
    Returns:
    
    the number of extents used or -1
    
    Since:
    
    1.0.0
  - getUnitsUsed
```
int getUnitsUsed()
```
    Returns the total number of units used by the associated PDS.
    -1 will be returned if the associated partitioned dataset is extended (is a PDSE).
    
    Returns:
    
    the number of units used or -1
    
    Since:
    
    1.0.0
  - getVolume
```
String getVolume()
```
    Returns the volume on which the associated partitioned dataset resides.
    
    Returns:
    
    the volume
    
    Since:
    
    1.0.0
  - getMaximumDirectoryBlocks
```
int getMaximumDirectoryBlocks()
```
    Returns the maximum number of directory blocks that the associated partitioned dataset can have.
    
    Returns:
    
    the maximum number of directory blocks
    
    Since:
    
    1.0.0
  - getMemberCount
```
int getMemberCount()
```
    Returns the number of members in the associated partitioned dataset.
    
    Returns:
    
    the number of members
    
    Since:
    
    1.0.0
  - getDirectoryBlocksUsed
```
int getDirectoryBlocksUsed()
```
    Returns the number of directory blocks used by the associated partitioned dataset.
    
    Returns:
    
    the number of directory blocks
    
    Since:
    
    1.0.0
  - isExtended
```
boolean isExtended()
```
    Returns whether the associated partitioned dataset is extended (is a PDSE).
    
    Returns:
    
    true if the associated partitioned dataset is extended, false otherwise
    
    Since:
    
    1.0.0

Interface IPartitionedDataSetCharacteristics

Method Summary

Methods inherited from interface com.compuware.api.topaz.hostresources.zos.IDataSetCharacteristics

Method Detail

getDataSet

getExtentsAllocated

getPrimaryUnitsAllocated

getSecondaryUnitsAllocated

getUnitsAllocated

getAllocationUnit

getBlockSize

getDataSetOrganization

getDeviceType

getLastUsedTTR

getLogicalRecordLength

getRecordFormat

getExtentsUsed

getUnitsUsed

getVolume

getMaximumDirectoryBlocks

getMemberCount

getDirectoryBlocksUsed

isExtended