Package com.compuware.api.topaz.hosts.zos

Class ZOSSystemException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.compuware.api.topaz.TopazAPIRuntimeException

com.compuware.api.topaz.hosts.zos.ZOSSystemException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ZOSAbendException

public class ZOSSystemException
extends TopazAPIRuntimeException

ZOSSystemException is an unchecked exception thrown when a z/OS system (non-abend) error occurs while performing an action on a z/OS host.

For a textual description of a z/OS system error, use Throwable.getMessage() or TopazAPIRuntimeException.getLocalizedMessage(). For further details regarding a specific Compuware return/reason code, see the "Topaz Workbench Messages and Codes" section of the Topaz Workbench Installation Guide.

Since:

1.0.0

Version:

2.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ZOSSystemException(String message, String localizedMessage, IZOSHost zosHost, int returnCode, String reasonCode)	Constructs a new ZOS system exception with the specified detail messages, z/OS host, return code and reason code.
ZOSSystemException(String message, String localizedMessage, Throwable cause, IZOSHost zosHost, int returnCode, String reasonCode)	Constructs a new ZOS system exception with the specified detail messages, cause, z/OS host, return code and reason code.

Method Summary

Modifier and Type	Method	Description
String	getReasonCode()	Returns Compuware's reason code for this error.
int	getReturnCode()	Returns Compuware's return code for this error.
IZOSHost	getZOSHost()	Returns the z/OS host on which this exception occurred.

Methods inherited from class com.compuware.api.topaz.TopazAPIRuntimeException

getLocalizedMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ZOSSystemException

public ZOSSystemException(String message,
                          String localizedMessage,
                          IZOSHost zosHost,
                          int returnCode,
                          String reasonCode)

Constructs a new ZOS system exception with the specified detail messages, z/OS host, return code and reason code. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:

message - the non-localized detail message (which is saved for later retrieval by the Throwable.getMessage() method).

localizedMessage - the localized description (which is saved for later retrieval by the TopazAPIRuntimeException.getLocalizedMessage() method). (A null value is permitted, in which case getLocalizedMessage() will return the non-localized detail message.)

zosHost - the z/OS host associated with this exception

returnCode - the Compuware return code

reasonCode - the Compuware reason code

Since:

1.0.0

ZOSSystemException

public ZOSSystemException(String message,
                          String localizedMessage,
                          Throwable cause,
                          IZOSHost zosHost,
                          int returnCode,
                          String reasonCode)

Constructs a new ZOS system exception with the specified detail messages, cause, z/OS host, return code and reason code.

Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:

message - the non-localized detail message (which is saved for later retrieval by the Throwable.getMessage() method).

localizedMessage - the localized description (which is saved for later retrieval by the TopazAPIRuntimeException.getLocalizedMessage() method). (A null value is permitted, in which case getLocalizedMessage() will return the non-localized detail message.)

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

zosHost - the z/OS host associated with this exception

returnCode - the Compuware return code

reasonCode - the Compuware reason code

Since:

1.0.0

Method Detail

getZOSHost

public IZOSHost getZOSHost()

Returns the z/OS host on which this exception occurred.

Returns:

the z/OS host

Since:

1.0.0

getReturnCode

public int getReturnCode()

Returns Compuware's return code for this error.

Returns:

the return code

Since:

1.0.0

getReasonCode

public String getReasonCode()

Returns Compuware's reason code for this error.

Returns:

the reason code

Since:

1.0.0