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

Interface IVSAMClusterCharacteristics

  • All Superinterfaces:
    IDataSetCharacteristics
    public interface IVSAMClusterCharacteristics
extends IDataSetCharacteristics
    VSAM cluster characteristics.

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

    Examples:
    To retrieve VSAM cluster characteristics: 

     IVSAMCluster vsamCluster = ...
 
 try {
     // fetch the VSAM cluster characteristics from the VSAM cluster
     IVSAMClusterCharacteristics vsamClusterCharacteristics = vsamCluster
             .fetchCharacteristics();
 
     ...
 } catch (DataSetAccessException e) {
     // the user does not have access to this VSAM cluster
     ...
 } catch (DataSetInUseException e) {
     // the VSAM cluster is enqueued by another user or job
     ...
 } catch (DataSetMigratedException e) {
     // the VSAM cluster has been migrated since it was first retrieved
     ...
 } catch (DataSetNotFoundException e) {
     // the VSAM cluster 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 IVSAMDataComponentCharacteristics see IVSAMDataComponentCharacteristics.
    For examples on how to retrieve IVSAMIndexComponentCharacteristics see IVSAMIndexComponentCharacteristics.
    For examples on how to retrieve generic IDataSetCharacteristics see IDataSetCharacteristics.
    For examples of how to retrieve IVSAMClusters see IVSAMCluster.

    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

      • getCatalog

        String getCatalog()
        Returns the catalog that contains the associated VSAM cluster.
        Returns:
        the catalog
        Since:
        1.0.0

      • getOwnerID

        String getOwnerID()
        Returns the ID of the owner of the associated VSAM cluster.
        Returns:
        the owner ID
        Since:
        1.0.0

      • getDataClass

        String getDataClass()
        Returns the data class of the associated VSAM cluster.
        Returns:
        the data class
        Since:
        1.0.0

      • getDataComponentCharacteristics

        IVSAMDataComponentCharacteristics getDataComponentCharacteristics()
        Returns the VSAM data component characteristics of the associated VSAM cluster.
        Returns:
        the VSAM data component characteristics
        Since:
        1.0.0

      • hasIndexComponent

        boolean hasIndexComponent()
        Returns whether the associated VSAM cluster has an index component.
        Returns:
        true if an index component exists, false otherwise
        Since:
        1.0.0
        See Also:
        getIndexComponentCharacteristics()