Skip navigation links

oracle.odi.exception
Class OdiCheckedException

java.lang.Object
java.lang.Throwable
java.lang.Exception
oracle.odi.exception.OdiCheckedException

All Implemented Interfaces:

java.io.Serializable

public abstract class OdiCheckedException

extends java.lang.Exception

Top level ODI SDK's checked exception class to be sub-classed by all specific custom checked exceptions of ODI SDK. This class is abstract to force the programmer to extend the class.

OdiCheckedExceptions are used to report a usually recoverable condition, while OdiUncheckedExceptions are used to report a usually unrecoverable condition.

OdiCheckedException provides I18N support to the exception messages using JDK's ResourceBundle.

Note: this class is not intended to be sub-classed by ODI SDK clients.

Since:

11.1.1.5.0

See Also:

Serialized Form

Method Summary

java.lang.String	getErrorID() Gets this exception's error ID.
oracle.odi.internal.util.MessageHandle	getErrorMsgHandle() Gets the error message handle.
java.lang.String	getLocalizedMessage() Gets this exception's error message for the default locale.
java.lang.String	getLocalizedMessage(java.util.Locale pLocale) Gets this exception's error message for the given locale.
java.lang.String	getMessage()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Method Detail

getLocalizedMessage

public java.lang.String getLocalizedMessage(java.util.Locale pLocale)

Gets this exception's error message for the given locale. This also returns the message for the cause of the exception. Note that if the cause exception provides a method getLocalizedMessage(Locale) then the message will be returned in the locale provided, otherwise it will be returned in the default locale.

Parameters:

pLocale - locale in which to return error message, or null if undefined (default locale will then be used)

Returns:

the localized error message

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Gets this exception's error message for the default locale.

Overrides:

getLocalizedMessage in class java.lang.Throwable

Returns:

the localized error message

See Also:

getLocalizedMessage(Locale)

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

getErrorMsgHandle

public oracle.odi.internal.util.MessageHandle getErrorMsgHandle()

Gets the error message handle.

Returns:

the error message handle

getErrorID

public java.lang.String getErrorID()

Gets this exception's error ID. For example, ODI-12345.

Returns:

the error ID

Skip navigation links