Package com.microstrategy.webapi
Class MSTRDocumentException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- com.microstrategy.utils.MSTRCheckedException
-
- com.microstrategy.webapi.MSTRWebAPIException
-
- com.microstrategy.webapi.MSTRDocumentException
-
- All Implemented Interfaces:
LocalizableException
,java.io.Serializable
public class MSTRDocumentException extends MSTRWebAPIException
- Since:
- MicroStrategy Web 7.5.0
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.utils.MSTRCheckedException
MSTRCheckedException.ExceptionXMLHandler
-
-
Constructor Summary
Constructors Constructor Description MSTRDocumentException(int code, java.lang.Object[] params, java.lang.Throwable e, java.util.Locale locale)
Construtor.MSTRDocumentException(int code, java.lang.Object[] params, java.util.Locale locale)
Construtor.MSTRDocumentException(LocalizableMessage errorMsg)
Construtor.MSTRDocumentException(LocalizableMessage errorMsg, java.lang.Throwable e)
Construtor.MSTRDocumentException(java.lang.String errorMsg)
Constructor.MSTRDocumentException(java.lang.String errorMsg, int errorCode)
Constructor.MSTRDocumentException(java.lang.String errorMsg, int errorCode, java.lang.Throwable e)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getMessage()
Returns the error message.java.lang.String
getMessage(boolean includeMainMessage, boolean includeReportMessages, java.lang.String newline)
java.lang.String
getReportErrorCode(int index)
java.lang.String
getReportErrorMessage(int index)
java.lang.String
getReportID(int index)
java.lang.String
getReportName(int index)
int
size()
-
Methods inherited from class com.microstrategy.webapi.MSTRWebAPIException
canRetry, isRetryable, setIsRetryable, setNoRetry
-
Methods inherited from class com.microstrategy.utils.MSTRCheckedException
getCause, getDefaultLocale, getErrorCode, getLocalizableMessage, getMessage, getMessage, getRootCause, getRootCause, setCause, setDefaultLocale, setXMLHandler
-
-
-
-
Constructor Detail
-
MSTRDocumentException
public MSTRDocumentException(LocalizableMessage errorMsg)
Construtor.- Parameters:
errorMsg
- The error message for this exception.- Since:
- MicroStrategy Web 8.0.0
-
MSTRDocumentException
public MSTRDocumentException(LocalizableMessage errorMsg, java.lang.Throwable e)
Construtor.- Parameters:
errorMsg
- The error message for this exception.e
- The embedded error.- Since:
- MicroStrategy Web 8.0.0
-
MSTRDocumentException
public MSTRDocumentException(int code, java.lang.Object[] params, java.util.Locale locale)
Construtor.- Parameters:
code
- Error code for this exception.locale
- The default locale for this exception.params
- The parameters required to generate the error message based on the error code.- Since:
- MicroStrategy Web 8.0.0
-
MSTRDocumentException
public MSTRDocumentException(int code, java.lang.Object[] params, java.lang.Throwable e, java.util.Locale locale)
Construtor.- Parameters:
code
- Error code for this exception.locale
- The default locale for this exception.params
- The parameters required to generate the error message based on the error code.e
- Embedded error.- Since:
- MicroStrategy Web 8.0.0
-
MSTRDocumentException
public MSTRDocumentException(java.lang.String errorMsg)
Constructor.- Parameters:
errorMsg
- Error message.
-
MSTRDocumentException
public MSTRDocumentException(java.lang.String errorMsg, int errorCode)
Constructor.- Parameters:
errorMsg
- Error messageerrorCode
- Error code
-
MSTRDocumentException
public MSTRDocumentException(java.lang.String errorMsg, int errorCode, java.lang.Throwable e)
Constructor.- Parameters:
errorMsg
- Error messageerrorCode
- Error codee
- Embedded error.
-
-
Method Detail
-
getReportID
public java.lang.String getReportID(int index)
-
getReportName
public java.lang.String getReportName(int index)
-
getReportErrorMessage
public java.lang.String getReportErrorMessage(int index)
-
getReportErrorCode
public java.lang.String getReportErrorCode(int index)
-
size
public int size()
-
getMessage
public java.lang.String getMessage()
Description copied from class:MSTRCheckedException
Returns the error message. If this is null and the error code is 0, it will first examine if there is an embedded exceptionMSTRCheckedException.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.- Specified by:
getMessage
in interfaceLocalizableException
- Overrides:
getMessage
in classMSTRCheckedException
- Returns:
- The error message.
-
getMessage
public java.lang.String getMessage(boolean includeMainMessage, boolean includeReportMessages, java.lang.String newline)
-
-