Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD com.ibm.portal.pcm.exception
Class DialogServiceExceptionjava.lang.Objectjava.lang.Throwable
java.lang.Exception
com.ibm.portal.pcm.exception.PCMException
com.ibm.portal.pcm.exception.DialogServiceException
- All Implemented Interfaces:
- Localized, java.io.Serializable
- Direct Known Subclasses:
- DialogStackManagerException
public class DialogServiceException- extends PCMException
- implements Localized
General exception for problems during all dialog service specific operations.
- Since:
- 8.0.0
- See Also:
- Serialized Form
Field Summary protected com.ibm.wps.util.MessageCode messageCode
The message of this exception.
Constructor Summary DialogServiceException(com.ibm.wps.util.MessageCode messageCode)
Creates a dialog service exception with the given message.DialogServiceException(com.ibm.wps.util.MessageCode messageCode, java.lang.Object object)
Creates a dialog service exception with the given message and a provided object for the message.DialogServiceException(com.ibm.wps.util.MessageCode messageCode, java.lang.Object[] objects)
Creates a dialog service exception with the given message and provided objects for the message.DialogServiceException(com.ibm.wps.util.MessageCode messageCode, java.lang.Object[] objects, java.lang.Throwable cause)
Creates a dialog service exception with the given message and provided objects for the message.DialogServiceException(com.ibm.wps.util.MessageCode messageCode, java.lang.Object object, java.lang.Throwable cause)
Creates a dialog service exception with the given message and a provided object for the message.DialogServiceException(com.ibm.wps.util.MessageCode messageCode, java.lang.Throwable cause)
Creates a dialog service exception with the given message.
Method Summary java.lang.String getDescription(java.util.Locale locale)
Return the description of this object in the given locale.ListModel<java.util.Locale> getLocales()
Return a list model containing the locales that are supported by this object.java.lang.String getTitle(java.util.Locale locale)
Return the title of this object in the given locale.
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
Field Detail messageCode
protected final com.ibm.wps.util.MessageCode messageCode
- The message of this exception.
Constructor Detail DialogServiceException
public DialogServiceException(com.ibm.wps.util.MessageCode messageCode, java.lang.Object[] objects, java.lang.Throwable cause)
- Creates a dialog service exception with the given message and provided objects for the message.
- Parameters:
- messageCode - The message of this exception
- objects - Objects for the message of this exception
- cause - Optional cause of this exception
DialogServiceException
public DialogServiceException(com.ibm.wps.util.MessageCode messageCode, java.lang.Object object, java.lang.Throwable cause)
- Creates a dialog service exception with the given message and a provided object for the message.
- Parameters:
- messageCode - The message of this exception
- object - Object for the message of this exception
- cause - Optional cause of this exception
DialogServiceException
public DialogServiceException(com.ibm.wps.util.MessageCode messageCode, java.lang.Throwable cause)
- Creates a dialog service exception with the given message.
- Parameters:
- messageCode - The message of this exception
- cause - Optional cause of this exception
DialogServiceException
public DialogServiceException(com.ibm.wps.util.MessageCode messageCode, java.lang.Object[] objects)
- Creates a dialog service exception with the given message and provided objects for the message.
- Parameters:
- messageCode - The message of this exception
- objects - Objects for the message of this exception
DialogServiceException
public DialogServiceException(com.ibm.wps.util.MessageCode messageCode, java.lang.Object object)
- Creates a dialog service exception with the given message and a provided object for the message.
- Parameters:
- messageCode - The message of this exception
- object - Object for the message of this exception
DialogServiceException
public DialogServiceException(com.ibm.wps.util.MessageCode messageCode)
- Creates a dialog service exception with the given message.
- Parameters:
- messageCode - The message of this exception
Method Detail getTitle
public java.lang.String getTitle(java.util.Locale locale)
- Description copied from interface: Localized
- Returns the title of this object in the given locale.
- Specified by:
- getTitle in interface Localized
- Parameters:
- locale - 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 locale)
- Description copied from interface: Localized
- Returns the description of this object in the given locale.
- Specified by:
- getDescription in interface Localized
- Parameters:
- locale - 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.
Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD