oracle.odi.domain.adapter

Interface IMessageHandle

public interface IMessageHandle

IMessageHandle represents a message associated with an error. The message is part of a language bundle. It includes the actual message, an ID, an error cause, and user action to avoid or fix the error.

Since:

12.1.2

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAction() Gets the action associated to this MessageHandle.
java.lang.String	getCause() Gets the cause associated to this IMessageHandle.
java.lang.Object	getErrorObject() Gets the object which is associated with the error, for example, a mapping.
java.lang.String	getMessage() Gets the translated message for the default locale.
java.lang.String	getMessage(java.util.Locale locale) Gets the translated message for the specified locale.
java.lang.String	getMessageID() Gets the message ID associated with this message handle.

Method Detail

getMessageID

java.lang.String getMessageID()

Gets the message ID associated with this message handle. The message ID is a numeric message identifier with the ODI prefix, for example, ODI-10001

Returns:

the message ID

Throws:

java.util.MissingResourceException - if resource cannot be found

getCause

java.lang.String getCause()

Gets the cause associated to this IMessageHandle. The cause is an explanation of the conditions that may have caused the error.

Returns:

the cause, or null if none

getAction

java.lang.String getAction()

Gets the action associated to this MessageHandle. The action is proposed user steps to avoid the error.

Returns:

the action, or null if none

getMessage

java.lang.String getMessage()

Gets the translated message for the default locale.

Returns:

translated message.

getMessage

java.lang.String getMessage(java.util.Locale locale)

Gets the translated message for the specified locale.

Returns:

translated message.

getErrorObject

java.lang.Object getErrorObject()

Gets the object which is associated with the error, for example, a mapping.

Returns:

object associated with the error.