com.ibm.itim.ui.exception
Class ITIMUIException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.ibm.itim.ui.exception.ITIMUIException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ITIMUISSOUserIdNotFoundException

public class ITIMUIException
extends java.lang.Exception

Base exception for internal error events propagated to the user interface.

See Also:

Serialized Form

Constructor Summary

ITIMUIException(java.lang.String message)
Creates an exception identified by the given message.

ITIMUIException(java.lang.String message, int msgType)
Creates an exception identified by the given message.

ITIMUIException(java.lang.String messageKey, java.lang.Object[] messageVars)
Creates an exception identified by the given message key.

ITIMUIException(java.lang.String messageKey, java.lang.Object[] messageArgs, java.lang.Throwable cause)
Creates an exception identified by the given message key and encapsulating another throwable.

ITIMUIException(java.lang.String message, java.lang.Throwable cause)
Creates an exception identified by the given message and encapsulating another throwable.

ITIMUIException(java.lang.Throwable cause)
Creates an exception encapsulating another throwable.

Method Summary

java.lang.String	getLocalizedMessage() Returns error message for the default locale.
java.lang.String	getMessage() Returns error message for the default locale.
java.lang.String	getMessage(java.util.Locale locale) Constructs a localized message for this exception for the specified locale.
java.lang.String	getMessageKey() Gets the message key identifying this exception.
java.lang.Object[]	getMessageVariables() Gives array of variables to substitute into the exception message.
java.lang.String	getTmsId(java.lang.String message) Gets the tms id from the exception.

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

Constructor Detail

ITIMUIException

public ITIMUIException(java.lang.String message)

Creates an exception identified by the given message.

Parameters:

message - an error message.

ITIMUIException

public ITIMUIException(java.lang.String message,
                       int msgType)

Creates an exception identified by the given message.

Parameters:

message - an error message.

msgType - constant from MessageInfo for error/warning/info

ITIMUIException

public ITIMUIException(java.lang.String messageKey,
                       java.lang.Object[] messageVars)

Creates an exception identified by the given message key.

Parameters:

messageKey - key for an error message.

messageVars - message variables.

ITIMUIException

public ITIMUIException(java.lang.Throwable cause)

Creates an exception encapsulating another throwable.

Parameters:

cause - root cause of this exception.

ITIMUIException

public ITIMUIException(java.lang.String message,
                       java.lang.Throwable cause)

Creates an exception identified by the given message and encapsulating another throwable.

Parameters:

message - an error message.

cause - root cause of this exception.

ITIMUIException

public ITIMUIException(java.lang.String messageKey,
                       java.lang.Object[] messageArgs,
                       java.lang.Throwable cause)

Creates an exception identified by the given message key and encapsulating another throwable.

Parameters:

messageKey - key for an error message.

messageArgs - arguments to the message key

cause - root cause of this exception.

Method Detail

getMessageKey

public java.lang.String getMessageKey()

Gets the message key identifying this exception.

Returns:

the message key identifying this exception.

getMessage

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

Constructs a localized message for this exception for the specified locale.

Parameters:

locale - the current locale.

Returns:

localized message for this exception.

getTmsId

public java.lang.String getTmsId(java.lang.String message)

Gets the tms id from the exception.

Returns:

tms id

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Returns error message for the default locale.

Overrides:

getLocalizedMessage in class java.lang.Throwable

Returns:

formatted, internationalized error message using the message id and token values defined in an object of this class.

getMessage

public java.lang.String getMessage()

Returns error message for the default locale.

Overrides:

getMessage in class java.lang.Throwable

Returns:

formatted, internationalized error message using the message id and token values defined in an object of this class.

getMessageVariables

public java.lang.Object[] getMessageVariables()

Gives array of variables to substitute into the exception message.

Returns:

variables to substitute into the exception message.