MSTRWebAPIException

Class Overview

Exception class for all errors thrown from the WebAPI. Field for error code and another exception added to regular exception's implementation. All functions in the Web API throw this object if an error occurs. In that case, the message field(which can be seen via getMessage()) will have the error message in text format, and the error code can be acquired by getErrorCode. The symbolic constants for each error code are in the class WebAPIErrorCodes. Finally, for exceptions where there was another exception thrown, this exception can be acquired by getWrappedException.

Summary

[Expand] Inherited Methods
From class com.microstrategy.utils.MSTRCheckedException Throwable getCause() Retrieves the embedded throwable (or null if none). Locale getDefaultLocale() Returns default locale of this exception. int getErrorCode() Returns the error code associated with the given error. LocalizableMessage getLocalizableMessage() Returns LocalizableMessage object of this exception. String getMessage(Locale locale) Returns localized error message of this exception. String getMessage() Returns the error message. String getMessage(boolean useXMLHandler) In some special scenarios, the message returned by the Intelligence Server is in XML form. static Throwable getRootCause(Throwable e) Throwable getRootCause() Follows the getCause chain to get the root cause. void setCause(Throwable e) Set the embedded error void setDefaultLocale(Locale locale) Sets the default locale of this exception. void setXMLHandler(MSTRCheckedException.ExceptionXMLHandler handler) In some special scenarios, the message returned by the Intelligence Server is in XML form.
From class java.lang.Throwable synchronized final void addSuppressed(Throwable arg0) synchronized Throwable fillInStackTrace() synchronized Throwable getCause() String getLocalizedMessage() String getMessage() StackTraceElement[] getStackTrace() synchronized final Throwable[] getSuppressed() synchronized Throwable initCause(Throwable arg0) void printStackTrace() void printStackTrace(PrintWriter arg0) void printStackTrace(PrintStream arg0) void setStackTrace(StackTraceElement[] arg0) String toString()
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface com.microstrategy.utils.LocalizableException abstract Locale getDefaultLocale() abstract int getErrorCode() abstract LocalizableMessage getLocalizableMessage() abstract String getMessage(Locale locale) abstract String getMessage() abstract void setDefaultLocale(Locale locale)