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

Provides classes and exceptions related to z/OS host resources.

Regarding the state of resource objects within this package: each resource object is a snapshot of that resource from the time it was retrieved from the host. In order to retrieve the current state of a resource, it will need to be re-retrieved from the host.

Note: Some resources may provide methods that retrieve data related to a resource at the time those methods are called. Such methods will be named with a prefix of "fetch" or "find" instead of "get", and the data retrieved from those methods will represent the state of that data from the time those methods are called, instead of the time that the resource was retrieved.

Since:

1.0.0

Interface Summary

Interface	Description
IAllocateParameters	Parameters specifying the attributes to use when allocating a new data set.
IDataSet	A dataset that resides on a z/OS host.
IDataSetCharacteristics	z/OS dataset characteristics.
IDataSetCommandProvider	Command provider for datasets.
IDefineGenerationDataGroupParameters	Parameters specifying the attributes to use when defining a new generation data group.
IEnqueueOwner	Representation of a user/job that has an enqueue on a z/OS dataset.
IGenerationDataGroup	A generation data group that resides on a z/OS host.
IMember	A member that resides on a z/OS host.
IMigratedDataSet	A migrated dataset that resides on a z/OS host.
IPartitionedDataSet	A partitioned dataset (PDS) that resides on a z/OS host.
IPartitionedDataSetCharacteristics	Partitioned dataset (PDS) characteristics.
IPartitionedDataSetMember	A partitioned dataset (PDS) member that resides on a z/OS host.
IPartitionedDataSetMemberStatistics	Partitioned dataset (PDS) member statistics.
ISequentialDataSet	A sequential dataset that resides on a z/OS host.
ISequentialDataSetCharacteristics	Sequential dataset characteristics.
IVSAMCluster	A VSAM cluster that resides on a z/OS host.
IVSAMClusterCharacteristics	VSAM cluster characteristics.
IVSAMDataComponentCharacteristics	VSAM data component characteristics.
IVSAMDataComponentStatistics	VSAM data component statistics.
IVSAMIndexComponentCharacteristics	VSAM index component characteristics.

Class Summary

Class	Description
AllocateParametersBuilder	Builder class used to create instances of IAllocateParameters.
DataSetReader	Reads text from a z/OS dataset, providing for the efficient reading of characters.
DataSetWriter	Writes text to a z/OS dataset, providing for the efficient writing of characters.
DefineGenerationDataGroupParametersBuilder	Builder class used to create instances of IDefineGenerationDataGroupParameters.
MemberReader	Reads text from a z/OS member, providing for the efficient reading of characters.
MemberWriter	Writes text to a z/OS member, providing for the efficient writing of characters.

Enum Summary

Enum	Description
AllocationUnit	Enumeration of z/OS allocation units.
DataSetOrganization	Enumeration of z/OS dataset organizations.
DataSetType	Enumeration of z/OS dataset types.
DeviceType	Enumeration of z/OS device types.
GenerationDataGroupType	Enumeration of z/OS generation data group types.
IAllocateParameters.AllocationUnit	Enumeration of the supported allocation units used for allocating a new data set.
IDefineGenerationDataGroupParameters.Ordering	Enumeration of the ordering types for a generation data group.
LoadOption	Enumeration of VSAM data component load options.
MemberType	Enumeration of z/OS member types.
RecordFormat	Enumeration of z/OS record formats.
VSAMOrganization	z/OS VSAM organizations.

Exception Summary

Exception	Description
AllocationFailedException	AllocationFailedException is a checked exception thrown when an an attempt to allocate a dataset fails.
DataSetAccessException	DataSetAccessException is a checked exception thrown when an attempt to perform an action on a dataset fails because the associated z/OS host credentials do not have access authority for that dataset.
DataSetExistsException	DataSetExistsException is a checked exception thrown when an an attempt to allocate a dataset fails because the dataset already exists.
DataSetInUseException	DataSetInUseException is a checked exception thrown when an attempt to perform an action on a dataset fails because it is in use.
DataSetMigratedException	DataSetMigratedException is a checked exception thrown when an attempt to perform an action on a dataset fails because the dataset is migrated.
DataSetNotFoundException	DataSetNotFoundException is a checked exception thrown when an an attempt to perform an action on a dataset fails because the dataset does not exist.
DataSetOutOfSpaceException	DataSetOutOfSpaceException is a checked exception thrown when an attempt to perform an action on a dataset fails because the dataset is out of space.
DefinitionFailedException	DefinitionFailedException is a checked exception thrown when an an attempt to define a generation data group fails.
GenerationDataGroupExistsException	GenerationDataGroupExistsException is a checked exception thrown when an an attempt to define a generation data group fails because the generation data group (or a like-named dataset) already exists.
GenerationDataGroupNotFoundException	GenerationDataGroupNotFoundException is a checked exception thrown when an an attempt to perform an action on a generation data group fails because the generation data group does not exist.
IndexComponentNotFoundException	IndexComponentNotFoundException is an unchecked exception thrown when an attempt to access the index component of a VSAM cluster fails because the VSAM cluster does not have an index component.
LogicalRecordLengthExceededException	LogicalRecordLengthExceededException is a checked exception thrown when an attempt to write data to a dataset resource exceeds the dataset's logical record length.
MemberAlreadyExistsException	MemberAlreadyExistsException is a checked exception thrown when attempting to create a PDS member that already exists.
MemberInUseException	MemberInUseException is a checked exception thrown when an attempt to perform an action on a partitioned dataset member fails because it is in use.
MemberNotFoundException	MemberNotFoundException is a checked exception thrown when an an attempt to perform an action on a member fails because the member does not exist.