Class 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
    • 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