com.ibm.portal.cp.resources.builder
Class ResourceBuilderException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.ibm.portal.cp.resources.builder.ResourceBuilderException
All Implemented Interfaces:
Localized, java.io.Serializable

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

Exception that can be thrown if errors occur within the com.ibm.portal.cp.resources.filter.ResourceFilter or com.ibm.portal.cp.resources.filter.ResourceFilterProvider.

Since:
7.0.0
See Also:
Serialized Form
Note:
This interface is designed to be implemented by clients.

Constructor Summary
protected ResourceBuilderException()
          Empty constructor
protected ResourceBuilderException(java.lang.Throwable cause)
          Initializes the exception with the reason of the exception.
 
Method Summary
 java.lang.String getDescription(java.util.Locale aLocale)
          Returns the description of this object in the given locale.
 ListModel<java.util.Locale> getLocales()
          Returns a list model containing the locales that are supported by this object.
 java.lang.String getLocalizedMessage()
           
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, 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
 
Methods inherited from interface com.ibm.portal.Localized
getTitle
 

Constructor Detail

ResourceBuilderException

protected ResourceBuilderException()
Empty constructor


ResourceBuilderException

protected ResourceBuilderException(java.lang.Throwable cause)
Initializes the exception with the reason of the exception.

Parameters:
cause - Root cause.
Method Detail

getDescription

public java.lang.String getDescription(java.util.Locale aLocale)
Description copied from interface: Localized
Returns the description of this object in the given 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()
Description copied from interface: Localized
Returns a list model containing the locales that are supported by this object. The presence of a locale in this list does not mean that a title and description is available, but rather that either one or both are available in that locale.

Specified by:
getLocales in interface Localized
Returns:
a list of locales defined for this object, returns an empty ListModel if no locales are supported.

getLocalizedMessage

public java.lang.String getLocalizedMessage()
Overrides:
getLocalizedMessage in class java.lang.Throwable