All Classes

All Classes Interface Summary Class Summary Enum Summary Exception Summary
Class	Description
AliasNotSupportedException	`AliasNotSupportedException` is an unchecked exception thrown to indicate aliases are not supported.
AllocateParametersBuilder	Builder class used to create instances of `IAllocateParameters`.
AllocationFailedException	`AllocationFailedException` is a checked exception thrown when an an attempt to allocate a dataset fails.
AllocationUnit	Enumeration of z/OS allocation units.
APIVersionNotSupportedException	`APIVersionNotSupportedException` is an unchecked exception thrown when the version of the Topaz API being used is not supported on the used host.
CodePage	Enumeration of z/OS code pages.
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.
DataSetOrganization	Enumeration of z/OS dataset organizations.
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.
DataSetReader	Reads text from a z/OS dataset, providing for the efficient reading of characters.
DataSetType	Enumeration of z/OS dataset types.
DataSetWriter	Writes text to a z/OS dataset, providing for the efficient writing of characters.
DefineGenerationDataGroupParametersBuilder	Builder class used to create instances of `IDefineGenerationDataGroupParameters`.
DefinitionFailedException	`DefinitionFailedException` is a checked exception thrown when an an attempt to define a generation data group fails.
DeniedByUserExitException	`DeniedByUserExitException` is an unchecked exception thrown when the site-specific job submission exit routine (CXTXSUBX) has denied a job submission.
DeviceType	Enumeration of z/OS device types.
DigitalCertificateException	`DigitalCertificateException` is a checked exception thrown when an attempt to connect to a host fails because the digital certificate is invalid.
ExecutionStatus	Enumeration of JES execution statuses.
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.
GenerationDataGroupType	Enumeration of z/OS generation data group types.
GroupException	`GroupException` is a checked exception thrown when an attempt to connect to a z/OS host fails because the group ID is not recognized, the associated user ID is not valid for the group, or the associated user ID is revoked from the group.
HostConnectionException	`HostConnectionException` is the superclass for all unchecked exceptions related to host connections.
HostCredentialsException	`HostCredentialsException` is the superclass for all checked exceptions related to invalid host credentials.
HostFactory	A factory class that provides methods for creating hosts.
HostIOException	`HostIOException` is an unchecked exception thrown when an exception occurs while reading or writing data over a host connection.
HostNotConnectedException	`HostNotConnectedException` is an unchecked exception that is thrown when an attempt to communicate to a host when the host is not connected.
HostNotDefinedException	`HostNotDefinedException` is an unchecked exception thrown when an attempt to perform an action on an `IHost` is made but that host is not defined in the Topaz Workbench preferences.
HostNotReachableException	`HostNotReachableException` is an unchecked exception thrown when an attempt to connect to a host is made but it is not reachable.
HostResourceException	`HostResourceException` is the superclass for all checked exceptions related to host resources.
HostResourceType	A host resource type.
HostType	Enumeration of Host types.
IAllocateParameters	Parameters specifying the attributes to use when allocating a new data set.
IAllocateParameters.AllocationUnit	Enumeration of the supported allocation units used for allocating a new data set.
ICredentials	Credentials for a host.
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.
IDefineGenerationDataGroupParameters.Ordering	Enumeration of the ordering types for a 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.
IHost	Generic interface for a host.
IHostConnection	Generic interface for a connection to a defined `IHost`.
IHostResource	A resource that resides on a host.
IJESCommandProvider	Command provider for JES related functions.
IJob	A job in the Job Entry Subsystem (JES).
IMember	A member that resides on a z/OS host.
IMigratedDataSet	A migrated dataset that resides on a z/OS host.
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.
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.
ISysoutDataDefinition	A Sysout Data Definition (DD).
ISystemLogDataDefinition	A System Log Data Definition
ITSOCommandProvider	Command provider for TSO related functions.
ITSOCommandResult	ITSOCommandResult provides the output from executing a TSO command
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.
IZOSCredentials	Credentials for a z/OS host.
IZOSHost	A z/OS host is used to create connections to a z/OS host.
IZOSHostConnection	A connection to a z/OS host.
IZOSUserProgramAbendEvent	The `IZOSUserProgramAbendEvent` is sent when a z/OS user program terminates abnormally.
IZOSUserProgramCompletionEvent	The `IZOSUserProgramCompletionEvent` represents an event that is sent when a z/OS user program completes normally.
IZOSUserProgramConnection	A connection to a z/OS user program.
IZOSUserProgramEvent	The `IZOSUserProgramEvent` represent a z/OS user program event.
IZOSUserProgramTerminationListener	The `IZOSUserProgramTerminationListener` interface is used to listen for termination events for a z/OS user program.
JESQueue	Enumeration of JES job queues.
JobCardException	`JobCardException` is an unchecked exception thrown when no valid job card could be found while attempting to submit a JCL stream.
JobInfo	Information about a job (the name and ID).
JobOutputReader	Reads text from a job output or DD for a job, providing for the efficient reading of characters.
JobStatus	Enumeration of JES job statuses.
LoadOption	Enumeration of VSAM data component load options.
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.
MemberReader	Reads text from a z/OS member, providing for the efficient reading of characters.
MemberType	Enumeration of z/OS member types.
MemberWriter	Writes text to a z/OS member, providing for the efficient writing of characters.
MethodNotSupportedException	`MethodNotSupportedException` is an unchecked exception thrown when a method called from the Topaz API is not supported on the used host.
PasswordException	`PasswordException` is the checked exception thrown when an attempt to connect to a host fails because the password is incorrect or is expired.
Protocol	Enumeration of supported encryption protocols to be used when creating a host.
RecordFormat	Enumeration of z/OS record formats.
TopazAPIException	`TopazAPIException` is the superclass for all Topaz API checked exceptions.
TopazAPIRuntimeException	`TopazAPIRuntimeException` is the superclass for all Topaz API unchecked exceptions.
UserIDException	`UserIDException` is the checked exception thrown when an attempt to connect to a host fails because the user ID is expired, not recognized, or revoked.
UserProgramConcurrentExecutionException	`UserProgramConcurrentExecutionException` is an unchecked exception thrown when an attempt to launch a user program is made while the same or another program is currently executing.
UserProgramException	`UserProgramException` is the superclass for all unchecked exceptions related to user programs.
UserProgramJCLErrorException	The `UserProgramJCLErrorException` unchecked exception thrown when an attempt to launch a user program is made but a JCL error occurred.
UserProgramLaunchException	`UserProgramLaunchException` is thrown when a launch is unable to determine the status of a user program launch request.
UserProgramNotExecutingException	`UserProgramNotExecutingException` is an unchecked exception thrown when an attempt to act on a user program is made but a user program is not currently executing.
UserProgramNotFoundException	`UserProgramNotFoundException` is thrown when a launch is unable to locate the specified user program.
VSAMOrganization	z/OS VSAM organizations.
ZOSAbendException	`ZOSAbendException` is an unchecked exception thrown when a z/OS system abend occurs while performing an action on a z/OS host.
ZOSCredentialsFactory	This factory is used to create z/OS credentials for connecting to z/OS hosts.
ZOSLicenseException	`ZOSLicenseException` is an unchecked exception thrown when a valid license cannot be found on a z/OS host.
ZOSSystemException	`ZOSSystemException` is an unchecked exception thrown when a z/OS system (non-abend) error occurs while performing an action on a z/OS host.