com.ibm.portal.resolver.exceptions
Class MessageCodeResolutionException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.ibm.portal.resolver.exceptions.ResolutionException
              extended by com.ibm.portal.resolver.exceptions.MessageCodeResolutionException
All Implemented Interfaces:
Localized, LocalizedStatus, Constants, java.io.Serializable

public abstract class MessageCodeResolutionException
extends ResolutionException

IOException wrapped into a ResolutionException

Since:
7.0.0.1
See Also:
Serialized Form

Field Summary
protected static java.lang.Object[] EMPTY_PARAMETERS
          the empty set of parameters, can be used for messages without params
 
Fields inherited from interface com.ibm.portal.resolver.exceptions.Constants
SC_BAD_REQUEST, SC_GONE, SC_INTERNAL_SERVER_ERROR, SC_NOT_FOUND, SC_REQUEST_TIMEOUT, SC_SERVICE_UNAVAILABLE, SC_UNAUTHORIZED
 
Constructor Summary
protected MessageCodeResolutionException()
           
protected MessageCodeResolutionException(java.lang.Throwable aCause)
          Initialize the exception
 
Method Summary
protected  Localized getDelegate()
          Localized object to delegate to
 ListModel<java.util.Locale> getLocales()
          Returns a list model containing the locales that are supported by this object.
 java.lang.String getLocalizedMessage()
           
protected abstract  com.ibm.wps.util.MessageCode getMessageCode()
          Returns the message code used to format the exception
protected abstract  java.lang.Object[] getMessageParameters(java.util.Locale aLocale)
          Returns the parameters used for formatting
 java.lang.String getTitle(java.util.Locale aLocale)
          Returns the title of this object in the given locale.
 
Methods inherited from class com.ibm.portal.resolver.exceptions.ResolutionException
findLocalized, findLocalizedStatus, getDescription, getLocalized, getLocalized, getLocalizedStatus, getMessage, getStatus, getTitle
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

EMPTY_PARAMETERS

protected static final java.lang.Object[] EMPTY_PARAMETERS
the empty set of parameters, can be used for messages without params

Since:
8.0.0.1
Constructor Detail

MessageCodeResolutionException

protected MessageCodeResolutionException()

MessageCodeResolutionException

protected MessageCodeResolutionException(java.lang.Throwable aCause)
Initialize the exception

Parameters:
aCause - the root cause
Method Detail

getDelegate

protected final Localized getDelegate()
Localized object to delegate to

Returns:
the localized object

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
Overrides:
getLocales in class ResolutionException
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 ResolutionException

getMessageCode

protected abstract com.ibm.wps.util.MessageCode getMessageCode()
Returns the message code used to format the exception

Returns:
the message code, not null

getMessageParameters

protected abstract java.lang.Object[] getMessageParameters(java.util.Locale aLocale)
Returns the parameters used for formatting

Parameters:
aLocale - locale used for formatting
Returns:
the parameters, not null

getTitle

public java.lang.String getTitle(java.util.Locale aLocale)
Description copied from interface: Localized
Returns the title of this object in the given locale.

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.