com.sap.ip.bi.sdk.exception
Class BIOlapQueryException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.sap.exception.BaseException
                    |
                    +--com.sap.ip.bi.sdk.exception.BIOlapQueryException

All Implemented Interfaces:

com.sap.exception.IBaseException, Serializable

public class BIOlapQueryException

extends com.sap.exception.BaseException

Checked exception which is thrown within the context of an OLAP query. This could happen when the query is manipulated or navigated, or when the query is executed.

Since:

3.50

See Also:

Serialized Form

Fields inherited from interface com.sap.exception.IBaseException

audit, defaultLocale

Constructor Summary

BIOlapQueryException(Locale locale, com.sap.tc.logging.Category cat, int severity, com.sap.tc.logging.Location loc, String patternKey, Object[] args, Throwable rootCause)
Constructs an exception with a localizable text message and the specified root cause of this exception.

BIOlapQueryException(Locale locale, String patternKey)
Constructs an exception with a localizable message.

BIOlapQueryException(Locale locale, String patternKey, Object[] args)
Constructs an exception with a localizable message.

BIOlapQueryException(Locale locale, String patternKey, Object[] args, Throwable cause)
Constructs an exception with a localizable message and a root cause.

BIOlapQueryException(Locale locale, String patternKey, Throwable cause)
Constructs an exception with a localizable message and a root cause.

BIOlapQueryException(Locale locale, Throwable rootCause)
Constructs an exception with the specified root cause of this exception.

Method Summary

void	finallyLocalize() Finally localizes the LocalizableText message (if there is one attached).
void	finallyLocalize(TimeZone timeZone) Finally localizes the LocalizableText message (if there is one attached).
String	getLocalizedMessage() Gets localized message.
String	getLocalizedMessage(TimeZone timeZone) Gets localized message.
String	getMessage() See getLocalizedMessage().
String	getNestedLocalizedMessage() Chains localized messages of the nested exceptions.
String	getNestedLocalizedMessage(TimeZone timeZone) Chains localized message of the nested exceptions.

Methods inherited from class com.sap.exception.BaseException

finallyLocalize, finallyLocalize, getCause, getLocalizableMessage, getLocalizedMessage, getLocalizedMessage, getLogCategory, getLogLocation, getLogSeverity, getNestedLocalizedMessage, getNestedLocalizedMessage, getNestedStackTraceString, getStackTraceString, getSystemStackTraceString, initCause, log, printStackTrace, printStackTrace, printStackTrace, restoreLogSettings, setLogSettings, trace, trace

Methods inherited from class java.lang.Throwable

fillInStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BIOlapQueryException

public BIOlapQueryException(Locale locale,
                            Throwable rootCause)

Constructs an exception with the specified root cause of this exception.

Parameters:

locale - locale with which to localize the message

rootCause - throwable object that caused this exception

BIOlapQueryException

public BIOlapQueryException(Locale locale,
                            com.sap.tc.logging.Category cat,
                            int severity,
                            com.sap.tc.logging.Location loc,
                            String patternKey,
                            Object[] args,
                            Throwable rootCause)

Constructs an exception with a localizable text message and the specified root cause of this exception.

Parameters:

locale - locale with which to localize the message

cat - logging category

severity - logging severity

loc - logging location

patternKey - message key

args - format arguments

rootCause - throwable object, which caused this exception

BIOlapQueryException

public BIOlapQueryException(Locale locale,
                            String patternKey)

Constructs an exception with a localizable message. The LocalizableTextFormatter class is used for the localizable message.

Parameters:

locale - locale with which to localize the message

patternKey - message key

BIOlapQueryException

public BIOlapQueryException(Locale locale,
                            String patternKey,
                            Object[] args)

Constructs an exception with a localizable message. The LocalizableTextFormatter class is used for the localizable message.

Parameters:

locale - locale with which to localize the message

patternKey - message key

args - format arguments

BIOlapQueryException

public BIOlapQueryException(Locale locale,
                            String patternKey,
                            Throwable cause)

Constructs an exception with a localizable message and a root cause. The LocalizableTextFormatter class is used for the localizable message.

Parameters:

locale - locale with which to localize the message

patternKey - message key

cause - root cause

BIOlapQueryException

public BIOlapQueryException(Locale locale,
                            String patternKey,
                            Object[] args,
                            Throwable cause)

Constructs an exception with a localizable message and a root cause. The LocalizableTextFormatter class is used for the localizable message.

Parameters:

locale - locale with which to localize the message

patternKey - message key

args - format arguments

cause - root cause

Method Detail

getLocalizedMessage

public String getLocalizedMessage()

Gets localized message.

The default locale and default time zone are used for localization.

These values have no effect if the finallyLocalize method has already been called.

Overrides:

getLocalizedMessage in class com.sap.exception.BaseException

Returns:

message string or null

getLocalizedMessage

public String getLocalizedMessage(TimeZone timeZone)

Gets localized message.

The specified time zone and the default locale are used for localization. The default time zone will be used, if the time zone parameter is null.

These values have no effect if the finallyLocalize method has been already called.

Overrides:

getLocalizedMessage in class com.sap.exception.BaseException

Parameters:

timeZone - time zone

Returns:

message string or null

getNestedLocalizedMessage

public String getNestedLocalizedMessage()

Chains localized messages of the nested exceptions.

The default locale and the default time zone are used for localization.

These values have no effect if the finallyLocalize method has already been called.

Overrides:

getNestedLocalizedMessage in class com.sap.exception.BaseException

Returns:

message string or null

getNestedLocalizedMessage

public String getNestedLocalizedMessage(TimeZone timeZone)

Chains localized message of the nested exceptions.

The specified time zone and the default locale are used for localization. The default time zone will be used, if the time zone parameter is null.

These values have no effect if the finallyLocalize method has been already called.

If the localized message is not specified, the non-localizable message is returned (if specified).

Overrides:

getNestedLocalizedMessage in class com.sap.exception.BaseException

Parameters:

timeZone - time zone

Returns:

message string or null

finallyLocalize

public void finallyLocalize()

Finally localizes the LocalizableText message (if there is one attached).

This means no further localization process can be performed on that object. If there is a nested exception implementing IBaseException, it will be localized recursively.

The default locale and the default time zone are used for localization.

Overrides:

finallyLocalize in class com.sap.exception.BaseException

finallyLocalize

public void finallyLocalize(TimeZone timeZone)

Finally localizes the LocalizableText message (if there is one attached).

This means no further localization process can be performed on that object. If there is a nested exception implementing IBaseException, it will be localized recursively.

The specified time zone and the default locale are used for localization. If time zone parameter is null, the default time zone will be used.

Overrides:

finallyLocalize in class com.sap.exception.BaseException

Parameters:

timeZone - time zone

getMessage

public String getMessage()

See getLocalizedMessage().

Overrides:

getMessage in class com.sap.exception.BaseException