public class

MSTRDocumentException

extends MSTRWebAPIException
java.lang.Object
   ↳ java.lang.Throwable
     ↳ java.lang.Exception
       ↳ com.microstrategy.utils.MSTRCheckedException
         ↳ com.microstrategy.webapi.MSTRWebAPIException
           ↳ com.microstrategy.webapi.MSTRDocumentException

Summary

Public Constructors
MSTRDocumentException(LocalizableMessage errorMsg)
Construtor.
MSTRDocumentException(LocalizableMessage errorMsg, Throwable e)
Construtor.
MSTRDocumentException(int code, Object[] params, Locale locale)
Construtor.
MSTRDocumentException(int code, Object[] params, Throwable e, Locale locale)
Construtor.
MSTRDocumentException(String errorMsg)
Constructor.
MSTRDocumentException(String errorMsg, int errorCode)
Constructor.
MSTRDocumentException(String errorMsg, int errorCode, Throwable e)
Constructor.
Public Methods
String getMessage(boolean includeMainMessage, boolean includeReportMessages, String newline)
String getMessage()
Returns the error message.
String getReportErrorMessage(int index)
String getReportID(int index)
String getReportName(int index)
int size()
[Expand]
Inherited Methods
From class com.microstrategy.webapi.MSTRWebAPIException
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 MSTRDocumentException (LocalizableMessage errorMsg)

Construtor.

Parameters
errorMsg The error message for this exception.

public MSTRDocumentException (LocalizableMessage errorMsg, Throwable e)

Construtor.

Parameters
errorMsg The error message for this exception.
e The embedded error.

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

Construtor.

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

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

Construtor.

Parameters
code Error code for this exception.
params The parameters required to generate the error message based on the error code.
e Embedded error.
locale The default locale for this exception.

public MSTRDocumentException (String errorMsg)

Constructor.

Parameters
errorMsg Error message.

public MSTRDocumentException (String errorMsg, int errorCode)

Constructor.

Parameters
errorMsg Error message
errorCode Error code

public MSTRDocumentException (String errorMsg, int errorCode, Throwable e)

Constructor.

Parameters
errorMsg Error message
errorCode Error code
e Embedded error.

Public Methods

public String getMessage (boolean includeMainMessage, boolean includeReportMessages, String newline)

public String getMessage ()

Returns the error message. If this is null and the error code is 0, it will first examine if there is an embedded exception getCause(), if so and it is either a MSTRCheckedException or MSTRUncheckedException, it will attempt to return their error message instead (recursively searching). If the message is not null or the error code is non-zero, the message of this exception is returned.

Returns
  • The error message.

public String getReportErrorMessage (int index)

public String getReportID (int index)

public String getReportName (int index)

public int size ()