Package com.microstrategy.web.preferences

Class PreferencesException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.microstrategy.utils.MSTRCheckedException

com.microstrategy.web.preferences.PreferencesException

All Implemented Interfaces:

LocalizableException, java.io.Serializable

public class PreferencesException
extends MSTRCheckedException

This problems encapsulates the problems which can occur during preference-related operations. This includes collating a key/name-exception Map of exceptions that occur during the validation phase when setting multiple value (see Preferences.setValues(Map)) - this allows the user to rectify all the problems at once.

Since:

MicroStrategy Web 7.3.1 or earlier

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.MSTRCheckedException

MSTRCheckedException.ExceptionXMLHandler

Constructor Summary

Constructors

Constructor	Description
PreferencesException()
PreferencesException(int errorCode)	Deprecated. use other constructor instead.
PreferencesException(int code, java.lang.Object[] params, java.lang.Throwable e, java.util.Locale locale)	Deprecated. use other constructor instead.
PreferencesException(int code, java.lang.Object[] params, java.util.Locale locale)	Deprecated. use other constructor instead
PreferencesException(LocalizableMessage errorMsg)	Constructor.
PreferencesException(LocalizableMessage errorMsg, java.lang.Throwable e)	Constructor.
PreferencesException(java.lang.String errorMsg)
PreferencesException(java.lang.String errorMsg, int errorCode)
PreferencesException(java.lang.Throwable e)

Method Summary

Modifier and Type	Method	Description
void	addValidationFailure(java.lang.String name, java.lang.Throwable e)	Marking preference as invalid
java.util.Map	getValidationExceptions()	Collection of key/name-exception pairs of validation exceptions.

Methods inherited from class com.microstrategy.utils.MSTRCheckedException

getCause, getDefaultLocale, getErrorCode, getLocalizableMessage, getMessage, getMessage, getMessage, getRootCause, getRootCause, setCause, setDefaultLocale, setXMLHandler

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getStackTrace, getSuppressed, 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

PreferencesException

public PreferencesException(LocalizableMessage errorMsg)

Constructor.

Parameters:

errorMsg - The localizable error message.

Since:

MicroStrategy Web 8.0.0

PreferencesException

public PreferencesException(LocalizableMessage errorMsg,
                            java.lang.Throwable e)

Constructor.

Parameters:

errorMsg - The localizable error message.

e - The embedded error.

Since:

MicroStrategy Web 8.0.0

PreferencesException

public PreferencesException(int code,
                            java.lang.Object[] params,
                            java.util.Locale locale)

Deprecated.

use other constructor instead

Constructor.

Since:

MicroStrategy Web 8.0.0

PreferencesException

public PreferencesException(int code,
                            java.lang.Object[] params,
                            java.lang.Throwable e,
                            java.util.Locale locale)

Deprecated.

use other constructor instead.

Constructor.

Since:

MicroStrategy Web 8.0.0

PreferencesException

public PreferencesException()

PreferencesException

public PreferencesException(java.lang.String errorMsg)

PreferencesException

public PreferencesException(int errorCode)

Deprecated.

use other constructor instead.

Constructor.

PreferencesException

public PreferencesException(java.lang.String errorMsg,
                            int errorCode)

PreferencesException

public PreferencesException(java.lang.Throwable e)

Method Detail

getValidationExceptions

public java.util.Map getValidationExceptions()

Collection of key/name-exception pairs of validation exceptions.

Returns:

Key/name-exception pairs of validation failures.

addValidationFailure

public void addValidationFailure(java.lang.String name,
                                 java.lang.Throwable e)

Marking preference as invalid

Parameters:

name - preference name

e - PreferencesException