Package com.compuware.api.topaz.hostconnections

Class UserProgramException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.compuware.api.topaz.TopazAPIRuntimeException

com.compuware.api.topaz.hostconnections.UserProgramException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

UserProgramConcurrentExecutionException, UserProgramJCLErrorException, UserProgramLaunchException, UserProgramNotExecutingException

public class UserProgramException
extends TopazAPIRuntimeException

UserProgramException is the superclass for all unchecked exceptions related to user programs.

Since:

2.0.0

Version:

1.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UserProgramException(String message, String localizedMessage, String userProcedureName, String userProgramName)	Constructs a new user program exception with the specified detail messages and user program name.
UserProgramException(String message, String localizedMessage, Throwable cause, String userProcedureName, String userProgramName)	Constructs a new user program exception with the specified detail messages, cause, and user program name.

Method Summary

Modifier and Type	Method	Description
String	getUserProcedureName()	Returns the name of the user procedure associated with this exception.
String	getUserProgramName()	Returns the name of the user program associated with this exception.

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

UserProgramException

public UserProgramException(String message,
                            String localizedMessage,
                            String userProcedureName,
                            String userProgramName)

Constructs a new user program exception with the specified detail messages and user program name. 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.)

userProcedureName - the name of the user procedure associated with this exception.

userProgramName - the name of the user program associated with this exception

Since:

1.0.0

UserProgramException

public UserProgramException(String message,
                            String localizedMessage,
                            Throwable cause,
                            String userProcedureName,
                            String userProgramName)

Constructs a new user program exception with the specified detail messages, cause, and user program name.

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.)

userProcedureName - the name of the user procedure associated with this exception.

userProgramName - the name of the user program associated with this exception

Since:

1.0.0

Method Detail

getUserProcedureName

public String getUserProcedureName()

Returns the name of the user procedure associated with this exception.

Returns:

the user procedure name

Since:

1.0.0

getUserProgramName

public String getUserProgramName()

Returns the name of the user program associated with this exception.

Returns:

the user program name

Since:

1.0.0