Skip navigation links

oracle.alm.common.message
Class ALMException

java.lang.Object
java.lang.Throwable
java.lang.Exception
oracle.alm.common.message.ALMException

All Implemented Interfaces:

java.io.Serializable

public class ALMException

extends java.lang.Exception

The ALMException provides the error reporting mechanism for connector writer to propogate errors inside connector to end user running Oracle Team Productivity Center (OTPC) inside JDeveloper. DocumentConnector and WorkItemConnector interface methods throw ALMException when something serious happens inside connector. Connector writer can put appropriate warning or message to the runtime instance of ALMException. OTPC client framework shows them to end user.

Since:

11.1.1.1.0

See Also:

Serialized Form

Constructor Summary

ALMException()

ALMException(java.lang.String method, java.lang.String message)
Constructs a new exception with the specified detail message.

ALMException(java.lang.String method, java.lang.String message, java.lang.Throwable cause)
Constructs a new exception with the specified detail message and cause.

ALMException(java.lang.String method, java.lang.Throwable cause)
Constructs a new exception with the specified cause.

Method Summary

javax.xml.namespace.QName	getExceptionCode() Retrieves the exception code
java.lang.String	getMethod() Retrieves the method name
void	setExceptionCode(javax.xml.namespace.QName exceptionCode) Sets the exception code
void	setMethod(java.lang.String method) Sets the method name

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ALMException

public ALMException()

ALMException

public ALMException(java.lang.String method,
                    java.lang.String message)

Constructs a new exception with the specified detail message.

Parameters:

method - name of the method throws the exception

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

ALMException

public ALMException(java.lang.String method,
                    java.lang.String message,
                    java.lang.Throwable cause)

Constructs a new exception with the specified detail message and cause.

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

Parameters:

method - name of the method throws the exception

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

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

ALMException

public ALMException(java.lang.String method,
                    java.lang.Throwable cause)

Constructs a new exception with the specified cause.

Parameters:

method - name of the method throws the exception

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

Method Detail

getMethod

public java.lang.String getMethod()

Retrieves the method name

Returns:

name of the method that throws the exception

setMethod

public void setMethod(java.lang.String method)

Sets the method name

Parameters:

method - name of the method that throws the exception

setExceptionCode

public void setExceptionCode(javax.xml.namespace.QName exceptionCode)

Sets the exception code

Parameters:

exceptionCode - the exception code

getExceptionCode

public javax.xml.namespace.QName getExceptionCode()

Retrieves the exception code

Returns:

A QName object hat contains the exception code

Skip navigation links