Package com.microstrategy.web.app

Class WebAppRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.microstrategy.utils.MSTRUncheckedException

com.microstrategy.web.app.WebAppRuntimeException

All Implemented Interfaces:

LocalizableException, java.io.Serializable

Direct Known Subclasses:

WebAppConfigurationRuntimeException

public class WebAppRuntimeException
extends MSTRUncheckedException

Exception class for all errors thrown from the Web app objects for unrecoverable error. This class extends MSTRUncheckedException class by providing Constructors based on other exceptions, a method to retrieve the original Exception and a method to return an error code.
All functions in the Web objects throw this object if an unexpected error or an error that cannot be solved through user input is generated.
The symbolic constants for each error code are in the class WebAppErrorCodes.

Since:

MicroStrategy Web 7.3.1 or earlier

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
WebAppRuntimeException()	Constructor.
WebAppRuntimeException(int errorCode)	Deprecated. use other constructor instead
WebAppRuntimeException(int errorCode, java.lang.Exception e)	Constructor to set an error code and an original Exception
WebAppRuntimeException(int code, java.lang.Object[] params, java.lang.Throwable e, java.util.Locale locale)	Deprecated. use other constructor instead
WebAppRuntimeException(int code, java.lang.Object[] params, java.util.Locale locale)	Deprecated. use other constructor instead
WebAppRuntimeException(LocalizableMessage errorMsg)	Constructor.
WebAppRuntimeException(LocalizableMessage errorMsg, java.lang.Throwable e)	Constructor.
WebAppRuntimeException(java.lang.Exception e)	Constructor.
WebAppRuntimeException(java.lang.String errorMsg)	Constructor.
WebAppRuntimeException(java.lang.String errorMsg, int errorCode)
WebAppRuntimeException(java.lang.String errorMsg, int errorCode, java.lang.Exception e)	Constructor.
WebAppRuntimeException(java.lang.String errorMsg, java.lang.Exception e)	Constructor to set an error message and an original Exception

Method Summary

Modifier and Type	Method	Description
java.lang.Exception	getWrappedException()	Deprecated. Use MSTRUncheckedException.getCause() instead.

Methods inherited from class com.microstrategy.utils.MSTRUncheckedException

getCause, getDefaultLocale, getErrorCode, getLocalizableMessage, getMessage, getMessage, getRootCause, setCause, setDefaultLocale

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WebAppRuntimeException

public WebAppRuntimeException(LocalizableMessage errorMsg)

Constructor.

Parameters:

errorMsg - The error message for this exception.

Since:

MicroStrategy Web 8.0.0

WebAppRuntimeException

public WebAppRuntimeException(LocalizableMessage errorMsg,
                              java.lang.Throwable e)

Constructor.

Parameters:

errorMsg - The error message for this exception.

e - The embedded error object.

Since:

MicroStrategy Web 8.0.0

WebAppRuntimeException

@Deprecated
public WebAppRuntimeException(int code,
                              java.lang.Object[] params,
                              java.util.Locale locale)

Deprecated.

use other constructor instead

Constructor.

Parameters:

code - error code.

locale - The locale to localize this exception.

params - The parameters required to constructing the error message based on error code.

Since:

MicroStrategy Web 8.0.0

WebAppRuntimeException

@Deprecated
public WebAppRuntimeException(int code,
                              java.lang.Object[] params,
                              java.lang.Throwable e,
                              java.util.Locale locale)

Deprecated.

use other constructor instead

Constructor.

Parameters:

code - error code.

locale - The locale to localize this exception.

params - The parameters required to constructing the error message based on error code.

Since:

MicroStrategy Web 8.0.0

WebAppRuntimeException

public WebAppRuntimeException()

Constructor.

WebAppRuntimeException

@Deprecated
public WebAppRuntimeException(int errorCode)

Deprecated.

use other constructor instead

Constructor.

Parameters:

errorCode - The error code for this exception.

WebAppRuntimeException

public WebAppRuntimeException(java.lang.String errorMsg)

Constructor.

Parameters:

errorMsg - The error message for this exception.

WebAppRuntimeException

public WebAppRuntimeException(java.lang.Exception e)

Constructor.

Parameters:

e - The embedded error.

WebAppRuntimeException

public WebAppRuntimeException(java.lang.String errorMsg,
                              int errorCode)

WebAppRuntimeException

public WebAppRuntimeException(java.lang.String errorMsg,
                              java.lang.Exception e)

Constructor to set an error message and an original Exception

Parameters:

errorMsg - The error message to set that field to upon creation.

e - The original Exception

WebAppRuntimeException

public WebAppRuntimeException(int errorCode,
                              java.lang.Exception e)

Constructor to set an error code and an original Exception

Parameters:

errorCode - The error code to set that field to upon creation.

e - The original Exception

WebAppRuntimeException

public WebAppRuntimeException(java.lang.String errorMsg,
                              int errorCode,
                              java.lang.Exception e)

Constructor.

Parameters:

errorCode - The error code for this exception.

errorMsg - The error message for this exception.

e - The original Exception

Method Detail

getWrappedException

@Deprecated
public java.lang.Exception getWrappedException()

Deprecated.

Use MSTRUncheckedException.getCause() instead.

Returns the Exception that was originally thrown and caught in the process of throwing this exception, if it exists. Note that if there was no such exception, this will return null.

Returns:

The original exception.