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

Interface IVSAMIndexComponentCharacteristics

  • public interface IVSAMIndexComponentCharacteristics
    VSAM index component characteristics.

    Examples:
    To retrieve VSAM index component characteristics: 

     IVSAMClusterCharacteristics vsamClusterCharacteristics = ...
 
 // check if the VSAM cluster has an index component
 if (vsamClusterCharacteristics.hasIndexComponent()) {
     // get the VSAM index component characteristics from the VSAM
     // cluster characteristics
     IVSAMIndexComponentCharacteristics vsamIndexComponentCharacteristics = vsamClusterCharacteristics
             .getIndexComponentCharacteristics();
 
     ...
 }
    For examples on how to retrieve IVSAMClusterCharacteristics see IVSAMClusterCharacteristics.
    For examples on how to retrieve IVSAMDataComponentCharacteristics see IVSAMDataComponentCharacteristics.
    Since:
    1.0.0
    Version:
    2.0.0
    See Also:
    IVSAMClusterCharacteristics.getIndexComponentCharacteristics()
    Restriction:
    This interface is not intended to be extended by clients.
    Restriction:
    This interface is not intended to be implemented by clients.

    • 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