com.ibm.portal.um.exceptions
Class PumaException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.ibm.portal.um.exceptions.PumaException

All Implemented Interfaces:

Localized, java.io.Serializable

Direct Known Subclasses:

PumaAttributeException, PumaMissingAccessRightsException, PumaModelException, PumaSystemException

public abstract class PumaException
extends java.lang.Exception
implements Localized

General top level exception for the com.ibm.wps.portal.um package.

Since:

5.1.0.1

See Also:

Serialized Form

Constructor Summary

protected	PumaException()
protected	PumaException(java.lang.Throwable cause)

Method Summary

java.lang.String	getDescription(java.util.Locale aLocale) Return a language-specific detailed explanation of this exception.
ListModel<java.util.Locale>	getLocales() Return the languages for which language-specific exception messages and explanations are provided.
java.lang.String	getTitle(java.util.Locale aLocale) Return a language-specific exception message for this exception.

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

PumaException

protected PumaException(java.lang.Throwable cause)

PumaException

protected PumaException()

Method Detail

getTitle

public java.lang.String getTitle(java.util.Locale aLocale)

Return a language-specific exception message for this exception. Returns null if no message is available for the requested locale.

Specified by:

getTitle in interface Localized

Parameters:

aLocale - the locale for which to retrieve the title, must not be null.

Returns:

the title of this node in the given locale. If a title is not available in the given locale, this method will return null. It is up to the invoker of the method to implement an appropriate fallback mechanism.

getDescription

public java.lang.String getDescription(java.util.Locale aLocale)

Return a language-specific detailed explanation of this exception. Returns null if no explanation is available for the requested locale.

Specified by:

getDescription in interface Localized

Parameters:

aLocale - the locale for which to retrieve the description, must not be null.

Returns:

the description of this node in the given locale. If a description is not available in the given locale, this method will return null. It is up to the invoker of the method to implement an appropriate fallback mechanism

getLocales

public ListModel<java.util.Locale> getLocales()

Return the languages for which language-specific exception messages and explanations are provided. Returns a ListModel with an empty iterator if no language-specific information is provided; never returns null.

Specified by:

getLocales in interface Localized

Returns:

a list of locales defined for this object, returns an empty ListModel if no locales are supported.