oracle.odi.km.exception

Class OdiKMException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

oracle.odi.exception.OdiUncheckedException

oracle.odi.km.exception.OdiKMException

All Implemented Interfaces:

java.io.Serializable

public class OdiKMException
extends OdiUncheckedException

Exception class that can be used by the KM tasks.

Note this exception is a runtime exception since these failures are considered fatal and will halt execution or code generation.

Since:

12.1.2

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OdiKMException(java.lang.String pKey) Constructor for KM error message.
OdiKMException(java.lang.String pKey, java.lang.Object[] pMsgArgs) Constructor for KM error message with Message arguments.
OdiKMException(java.lang.String pKey, java.lang.String pOverrideMessage) A KM exception whose message is given by pKey.
OdiKMException(java.lang.String pKey, java.lang.String pOverrideMessage, java.lang.Object[] pMsgArgs) A KM exception whose message is given by pKey and may be parameterized by pMsgArgs.
OdiKMException(java.lang.Throwable pCause, java.lang.String pKey, java.lang.Object[] pMsgArgs) Allow the KM exception to have a Causal exception
OdiKMException(java.lang.Throwable pCause, java.lang.String pKey, java.lang.String pOverrideMessage, java.lang.Object[] pMsgArgs) Allow the KM exception to have a parameterized message, and a Causal exception and an OverrideMessage

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getSourceObject() Retrieve the source object associated with this exception
void	setSourceObject(java.lang.Object pSourceObject) Set the source object associated with this exception

Methods inherited from class oracle.odi.exception.OdiUncheckedException

getErrorID, getErrorMsgHandle, getLocalizedMessage, getLocalizedMessage, getMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, 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

OdiKMException

public OdiKMException(java.lang.String pKey)

Constructor for KM error message.

Parameters:

pKey - Key to custom error message.

OdiKMException

public OdiKMException(java.lang.String pKey,
                      java.lang.Object[] pMsgArgs)

Constructor for KM error message with Message arguments.

Parameters:

pKey - Key to custom error message.

pMsgArgs - error message arguments, as an array because it is accessible from Jython.

OdiKMException

public OdiKMException(java.lang.String pKey,
                      java.lang.String pOverrideMessage)

A KM exception whose message is given by pKey. A pOverrideMessage can be specified. Assuming the pKey exists in the ResourceBundle, then if the English text for the pKey text is not equal to pOverrideMessage, then pOverrideMessage will be used, otherwise pKey.text will be used from the ResourceBundle. This allows pOverrideMessage to be able to override the message in the ResourceBundle. In this case, the pOverrideMessage should contain the MSGID, e.g. new OdiKMException("KMTest001", "ODI-KM-123: This Msg has no parameters");

OdiKMException

public OdiKMException(java.lang.String pKey,
                      java.lang.String pOverrideMessage,
                      java.lang.Object[] pMsgArgs)

A KM exception whose message is given by pKey and may be parameterized by pMsgArgs. A pOverrideMessage can be specified. Assuming the pKey exists in the ResourceBundle, then if the English text for the pKey text is not equal to pOverrideMessage, then pOverrideMessage + pMsgArgs will be used, otherwise pKey.text + pMsgArgs will be used from the ResourceBundle. This allows pOverrideMessage to be able to override the message in the ResourceBundle. In this case, the pOverrideMessage should contain the MSGID, e.g. new OdiKMException("KMTest001", "ODI-KM-123: Msg is in {0} and not in {1}", [ "KM", "ResourceBundle"]);

OdiKMException

public OdiKMException(java.lang.Throwable pCause,
                      java.lang.String pKey,
                      java.lang.Object[] pMsgArgs)

Allow the KM exception to have a Causal exception

OdiKMException

public OdiKMException(java.lang.Throwable pCause,
                      java.lang.String pKey,
                      java.lang.String pOverrideMessage,
                      java.lang.Object[] pMsgArgs)

Allow the KM exception to have a parameterized message, and a Causal exception and an OverrideMessage

Method Detail

setSourceObject

public void setSourceObject(java.lang.Object pSourceObject)

Set the source object associated with this exception

Parameters:

pObject - Source object associated with this exception

getSourceObject

public java.lang.Object getSourceObject()

Retrieve the source object associated with this exception

Returns:

Source object associated with this exception