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

Interface IVSAMCluster

All Superinterfaces:

IDataSet, IHostResource

public interface IVSAMCluster
extends IDataSet

A VSAM cluster that resides on a z/OS host.

For details on the state of an IVSAMCluster and the function of its methods, see IHostResource.

Examples:
To retrieve a VSAM cluster:

 IDataSetCommandProvider commandProvider = ...
 String vsamClusterName = ...
 
 // vsamCluster will be null if it cannot be found
 IVSAMCluster vsamCluster = commandProvider
         .findVSAMCluster(vsamClusterName);
 

To retrieve a list of VSAM clusters matching a filter:

 IDataSetCommandProvider commandProvider = ...
 String dataSetFilter = ...
 
 // vsamClusters will be empty if no VSAM clusters match the dataset
 // filter
 List<IVSAMCluster> vsamClusters = commandProvider
         .findVSAMClusters(dataSetFilter);
 

For examples on how to obtain an IDataSetCommandProvider see IDataSetCommandProvider.
For examples of how to retrieve generic IDataSets see IDataSet.

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

Modifier and Type	Method	Description
IVSAMClusterCharacteristics	fetchCharacteristics()	Fetches the characteristics of this VSAM cluster from the z/OS host on which it resides.
VSAMOrganization	getOrganization()	Returns the organization of this VSAM cluster.

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

delete, getHostConnection, getType, isAlias

Methods inherited from interface com.compuware.api.topaz.hostresources.IHostResource

getName

Method Detail

fetchCharacteristics

IVSAMClusterCharacteristics fetchCharacteristics()
                                          throws DataSetAccessException,
                                                 DataSetInUseException,
                                                 DataSetMigratedException,
                                                 DataSetNotFoundException

Fetches the characteristics of this VSAM cluster from the z/OS host on which it resides.

The state of the VSAM cluster characteristics returned from this method is a snapshot of these characteristics from the time this method is called. Any changes made to these characteristics after this method is called will not be reflected in any previously returned VSAM cluster characteristics. This method may be called again to retrieve a current snapshot of the VSAM cluster characteristics.

Specified by:

fetchCharacteristics in interface IDataSet

Returns:

the VSAM cluster characteristics

Throws:

ZOSSystemException - if a z/OS system error occurs

ZOSAbendException - if a z/OS ABEND occurs

DataSetAccessException - if the user's credentials do not grant access authority for this VSAM cluster

DataSetInUseException - if an exclusive enqueue exists on this VSAM cluster

DataSetMigratedException - if this VSAM cluster is migrated (this may occur if the dataset is migrated after it is retrieved from the z/OS host)

DataSetNotFoundException - if this VSAM cluster no longer exists (this may occur if the dataset is deleted after it is retrieved from the z/OS host)

Since:

1.0.0

getOrganization

VSAMOrganization getOrganization()

Returns the organization of this VSAM cluster.

Note: the value returned from this method represents the state of this resource from the time it was retrieved from the host. Any changes made to this resource since it was retrieved will not be reflected in this method.

Returns:

the VSAM organization

Since:

1.0.0