public class

MSTRWebAPIException

extends MSTRCheckedException
java.lang.Object
   ↳ java.lang.Throwable
     ↳ java.lang.Exception
       ↳ com.microstrategy.utils.MSTRCheckedException
         ↳ com.microstrategy.webapi.MSTRWebAPIException
Known Direct Subclasses

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

Public Constructors
MSTRWebAPIException(LocalizableMessage errorMsg)
Constructor.
MSTRWebAPIException(LocalizableMessage errorMsg, Throwable e)
Constructor.
MSTRWebAPIException(int code, Object[] params, Locale locale)
Constructor.
MSTRWebAPIException(int code, Object[] params, Throwable e, Locale locale)
Constructor.
Protected Constructors
MSTRWebAPIException()
MSTRWebAPIException(String errorMsg)
MSTRWebAPIException(Throwable e)
MSTRWebAPIException(int errorCode)
MSTRWebAPIException(String errorMsg, int errorCode)
MSTRWebAPIException(String errorMsg, int errorCode, Throwable e)
Protected Methods
boolean canRetry()
void setNoRetry(boolean value)
[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 MSTRWebAPIException (LocalizableMessage errorMsg)

Constructor.

Parameters
errorMsg error message

public MSTRWebAPIException (LocalizableMessage errorMsg, Throwable e)

Constructor.

Parameters
errorMsg error message
e Embedded error

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

Constructor.

Parameters
code error code
params parameters required to generate error message based on error code
locale default locale for this exception

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

Constructor.

Parameters
code error code
params parameters required to generate error message based on error code
e embedded error
locale default locale for this exception

Protected Constructors

protected MSTRWebAPIException ()

protected MSTRWebAPIException (String errorMsg)

protected MSTRWebAPIException (Throwable e)

protected MSTRWebAPIException (int errorCode)

protected MSTRWebAPIException (String errorMsg, int errorCode)

protected MSTRWebAPIException (String errorMsg, int errorCode, Throwable e)

Protected Methods

protected boolean canRetry ()

protected void setNoRetry (boolean value)