public class

PreferencesException

extends MSTRCheckedException
java.lang.Object
   ↳ java.lang.Throwable
     ↳ java.lang.Exception
       ↳ com.microstrategy.utils.MSTRCheckedException
         ↳ com.microstrategy.web.preferences.PreferencesException

Class Overview

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 setValues(Map)) - this allows the user to rectify all the problems at once.

Summary

Public Constructors
PreferencesException(LocalizableMessage errorMsg)
Constructor.
PreferencesException(LocalizableMessage errorMsg, Throwable e)
Constructor.
PreferencesException(int code, Object[] params, Locale locale)
This constructor is deprecated. use other constructor instead
PreferencesException(int code, Object[] params, Throwable e, Locale locale)
This constructor is deprecated. use other constructor instead.
PreferencesException()
PreferencesException(String errorMsg)
PreferencesException(int errorCode)
This constructor is deprecated. use other constructor instead.
PreferencesException(String errorMsg, int errorCode)
PreferencesException(Throwable e)
Public Methods
void addValidationFailure(String name, Throwable e)
Marking preference as invalid
Map getValidationExceptions()
Collection of key/name-exception pairs of validation exceptions.
[Expand]
Inherited Methods
From class com.microstrategy.utils.MSTRCheckedException
From class java.lang.Throwable
From class java.lang.Object
From interface com.microstrategy.utils.LocalizableException

Public Constructors

public PreferencesException (LocalizableMessage errorMsg)

Constructor.

Parameters
errorMsg The localizable error message.

public PreferencesException (LocalizableMessage errorMsg, Throwable e)

Constructor.

Parameters
errorMsg The localizable error message.
e The embedded error.

public PreferencesException (int code, Object[] params, Locale locale)

This constructor is deprecated.
use other constructor instead

Constructor.

public PreferencesException (int code, Object[] params, Throwable e, Locale locale)

This constructor is deprecated.
use other constructor instead.

Constructor.

public PreferencesException ()

public PreferencesException (String errorMsg)

public PreferencesException (int errorCode)

This constructor is deprecated.
use other constructor instead.

Constructor.

public PreferencesException (String errorMsg, int errorCode)

public PreferencesException (Throwable e)

Public Methods

public void addValidationFailure (String name, Throwable e)

Marking preference as invalid

Parameters
name preference name
e PreferencesException

public Map getValidationExceptions ()

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

Returns
  • Key/name-exception pairs of validation failures.