```
public interface IVSAMDataComponentCharacteristics
```
VSAM data component characteristics.
Examples:
To retrieve VSAM data component characteristics:
```
 IVSAMClusterCharacteristics vsamClusterCharacteristics = ...
 
 // get the VSAM data component characteristics from the VSAM cluster
 // characteristics
 IVSAMDataComponentCharacteristics vsamDataComponentCharacteristics = vsamClusterCharacteristics
         .getDataComponentCharacteristics();
 
```
For examples on how to retrieve IVSAMClusterCharacteristics see IVSAMClusterCharacteristics.
For examples on how to retrieve IVSAMDataComponentStatistics see IVSAMDataComponentStatistics.
For examples on how to retrieve IVSAMIndexComponentCharacteristics see IVSAMIndexComponentCharacteristics.
Since:

1.0.0

Version:

2.0.0

See Also:

IVSAMClusterCharacteristics.getDataComponentCharacteristics()

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 VSAM component.
`int`	`getAverageRecordSize()`	Returns the average record size of the associated VSAM data component.
`int`	`getBufferSpace()`	Returns the amount of buffer space (in bytes) that the associated VSAM data component has.
`float`	`getControlAreaPercentFreeSpace()`	Returns the percentage of free space in the control area (CA) of the associated VSAM data component.
`float`	`getControlIntervalPercentFreeSpace()`	Returns the percentage of free space in the control interval (CI) of the associated VSAM data component.
`int`	`getControlIntervalSize()`	Returns the size of the control interval of the associated VSAM component.
`DeviceType`	`getDeviceType()`	Returns the type of device on which the associated VSAM component resides.
`int`	`getExtentsAllocated()`	Returns the number of extents allocated to the associated VSAM component.
`long`	`getHighestAllocatedRBA()`	Returns the highest allocated relative byte address (RBA) in the associated VSAM component.
`long`	`getHighestUsedRBA()`	Returns the highest used relative byte address (RBA) in the associated VSAM component.
`int`	`getKeyLength()`	Returns the key length (in bytes) for the associated VSAM data component.
`int`	`getKeyPosition()`	Returns the position offset (relative to zero) of where the key area starts within the record for the associated VSAM data component.
`LoadOption`	`getLoadOption()`	Returns the load option of the associated VSAM data component.
`int`	`getMaximumRecordSize()`	Returns the maximum record size of the associated VSAM data component.
`String`	`getName()`	Returns the name of the associated VSAM component.
`int`	`getPrimaryUnitsAllocated()`	Returns the number of primary (first extent) units that are allocated to the associated VSAM component.
`int`	`getRegionShareOption()`	Returns the region share option for the associated VSAM component.
`int`	`getSecondaryUnitsAllocated()`	Returns the number of secondary units that are allocated to the associated VSAM component.
`IVSAMDataComponentStatistics`	`getStatistics()`	Returns the statistics of the associated VSAM data component.
`int`	`getSystemShareOption()`	Returns the system share option for the associated VSAM component.
`String`	`getVolume()`	Returns the volume on which the associated VSAM component resides.
`IVSAMClusterCharacteristics`	`getVSAMClusterCharacterisitcs()`	Returns the associated VSAM cluster characteristics.
`boolean`	`isClusterReusable()`	Returns whether the associated VSAM component's cluster is reusable.
`boolean`	`isEraseOnDeleteEnabled()`	Returns whether records are erased after deletion for the associated VSAM data component.
`boolean`	`isRecordSpanEnabled()`	Returns whether records can span control intervals for the associated VSAM data component.
`boolean`	`isWriteCheckEnabled()`	Returns whether write checking is enabled for the associated VSAM component.

- Method Detail
  - getVSAMClusterCharacterisitcs
```
IVSAMClusterCharacteristics getVSAMClusterCharacterisitcs()
```
    Returns the associated VSAM cluster characteristics.
    
    Returns:
    
    the VSAM cluster characteristics
    
    Since:
    
    1.0.0
  - getName
```
String getName()
```
    Returns the name of the associated VSAM component.
    
    Returns:
    
    the VSAM component name
    
    Since:
    
    1.0.0
  - getVolume
```
String getVolume()
```
    Returns the volume on which the associated VSAM component resides.
    
    Returns:
    
    the volume
    
    Since:
    
    1.0.0
  - getDeviceType
```
DeviceType getDeviceType()
```
    Returns the type of device on which the associated VSAM component resides.
    
    Returns:
    
    the device type
    
    Since:
    
    1.0.0
  - getAllocationUnit
```
AllocationUnit getAllocationUnit()
```
    Returns the allocation unit of the associated VSAM component.
    
    Returns:
    
    the allocation unit
    
    Since:
    
    1.0.0
  - getPrimaryUnitsAllocated
```
int getPrimaryUnitsAllocated()
```
    Returns the number of primary (first extent) units that are allocated to the associated VSAM component.
    
    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 VSAM component.
    
    Returns:
    
    the number of secondary units allocated
    
    Since:
    
    1.0.0
  - getControlIntervalSize
```
int getControlIntervalSize()
```
    Returns the size of the control interval of the associated VSAM component.
    
    Returns:
    
    the control interval size
    
    Since:
    
    1.0.0
  - isClusterReusable
```
boolean isClusterReusable()
```
    Returns whether the associated VSAM component's cluster is reusable.
    
    Returns:
    
    true if the associated VSAM component's cluster is reusable, false otherwise
    
    Since:
    
    1.0.0
  - isWriteCheckEnabled
```
boolean isWriteCheckEnabled()
```
    Returns whether write checking is enabled for the associated VSAM component.
    
    Returns:
    
    true if write checking is enabled, false otherwise
    
    Since:
    
    1.0.0
  - getRegionShareOption
```
int getRegionShareOption()
```
    Returns the region share option for the associated VSAM component.
    
    Returns:
    
    the region share option
    
    Since:
    
    1.0.0
  - getSystemShareOption
```
int getSystemShareOption()
```
    Returns the system share option for the associated VSAM component.
    
    Returns:
    
    the system share option
    
    Since:
    
    1.0.0
  - getExtentsAllocated
```
int getExtentsAllocated()
```
    Returns the number of extents allocated to the associated VSAM component.
    
    Returns:
    
    the number of extents allocated
    
    Since:
    
    1.0.0
  - getHighestAllocatedRBA
```
long getHighestAllocatedRBA()
```
    Returns the highest allocated relative byte address (RBA) in the associated VSAM component.
    
    Returns:
    
    the highest allocated RBA
    
    Since:
    
    1.0.0
  - getHighestUsedRBA
```
long getHighestUsedRBA()
```
    Returns the highest used relative byte address (RBA) in the associated VSAM component.
    
    Returns:
    
    the highest used RBA
    
    Since:
    
    1.0.0
  - getAverageRecordSize
```
int getAverageRecordSize()
```
    Returns the average record size of the associated VSAM data component.
    -1 will be returned if the associated VSAM cluster had an organization type of VSAMOrganization.LINEAR
    
    Returns:
    
    the average record size or -1
    
    Since:
    
    1.0.0
  - getMaximumRecordSize
```
int getMaximumRecordSize()
```
    Returns the maximum record size of the associated VSAM data component.
    -1 will be returned if the associated VSAM cluster had an organization type of VSAMOrganization.LINEAR
    
    Returns:
    
    the maximum record size or -1
    
    Since:
    
    1.0.0
  - getBufferSpace
```
int getBufferSpace()
```
    Returns the amount of buffer space (in bytes) that the associated VSAM data component has.
    
    Returns:
    
    the number of bytes of buffer space
    
    Since:
    
    1.0.0
  - getKeyPosition
```
int getKeyPosition()
```
    Returns the position offset (relative to zero) of where the key area starts within the record for the associated VSAM data component.
    -1 will be returned if the associated VSAM cluster had an organization type of VSAMOrganization.LINEAR
    
    Returns:
    
    the key position or -1
    
    Since:
    
    1.0.0
  - getKeyLength
```
int getKeyLength()
```
    Returns the key length (in bytes) for the associated VSAM data component.
    -1 will be returned if the associated VSAM cluster had an organization type of VSAMOrganization.LINEAR
    
    Returns:
    
    the key length or -1
    
    Since:
    
    1.0.0
  - isEraseOnDeleteEnabled
```
boolean isEraseOnDeleteEnabled()
```
    Returns whether records are erased after deletion for the associated VSAM data component.
    
    Returns:
    
    true if erase on delete is enabled, false otherwise
    
    Since:
    
    1.0.0
  - getLoadOption
```
LoadOption getLoadOption()
```
    Returns the load option of the associated VSAM data component.
    
    Returns:
    
    the load option
    
    Since:
    
    1.0.0
  - isRecordSpanEnabled
```
boolean isRecordSpanEnabled()
```
    Returns whether records can span control intervals for the associated VSAM data component.
    false will be returned if the associated VSAM cluster had an organization type of VSAMOrganization.LINEAR
    
    Returns:
    
    true if records can span control intervals, false otherwise
    
    Since:
    
    1.0.0
  - getControlIntervalPercentFreeSpace
```
float getControlIntervalPercentFreeSpace()
```
    Returns the percentage of free space in the control interval (CI) of the associated VSAM data component.
    
    Returns:
    
    the percentage of CI free space
    
    Since:
    
    1.0.0
  - getControlAreaPercentFreeSpace
```
float getControlAreaPercentFreeSpace()
```
    Returns the percentage of free space in the control area (CA) of the associated VSAM data component.
    
    Returns:
    
    the percentage of CA free space
    
    Since:
    
    1.0.0
  - getStatistics
```
IVSAMDataComponentStatistics getStatistics()
```
    Returns the statistics of the associated VSAM data component.
    
    Returns:
    
    the VSAM data component statistics
    
    Since:
    
    1.0.0

Interface IVSAMDataComponentCharacteristics

Method Summary

Method Detail

getVSAMClusterCharacterisitcs

getName

getVolume

getDeviceType

getAllocationUnit

getPrimaryUnitsAllocated

getSecondaryUnitsAllocated

getControlIntervalSize

isClusterReusable

isWriteCheckEnabled

getRegionShareOption

getSystemShareOption

getExtentsAllocated

getHighestAllocatedRBA

getHighestUsedRBA

getAverageRecordSize

getMaximumRecordSize

getBufferSpace

getKeyPosition

getKeyLength

isEraseOnDeleteEnabled

getLoadOption

isRecordSpanEnabled

getControlIntervalPercentFreeSpace

getControlAreaPercentFreeSpace

getStatistics