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

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

All Implemented Interfaces:

com.sap.exception.IBaseException, Serializable

public class BIException

extends com.sap.exception.BaseException

General-purpose exception for the BI Java SDK.

Since:

3.50

See Also:

Serialized Form

Fields inherited from interface com.sap.exception.IBaseException

audit, defaultLocale

Constructor Summary

BIException(Locale locale)
Creates an empty collection of messages and constructs a BIException object in which the description defaults to null and the state defaults to null.

BIException(Locale locale, com.sap.tc.logging.Category category, int severity, com.sap.tc.logging.Location location, String messageId, Object[] args, Throwable cause)
Constructs a BIException object with log handling.

BIException(Locale locale, com.sap.tc.logging.Category category, int severity, com.sap.tc.logging.Location location, String messageId, Throwable cause)
Constructs a BIException object with log handling.

BIException(Locale locale, String messageId)
Constructs a BIException object with the given description.

BIException(Locale locale, String messageId, Object[] args)
Constructs a BIException object with the given description.

BIException(Locale locale, String messageId, Object[] obj, Throwable cause)
Constructs a BIException object with message ID, message arguments, and original exception.

BIException(Locale locale, String messageId, Throwable cause)
Constructs a BIException with the given description and stores the original exception.

BIException(Locale locale, Throwable cause)
Constructs a BIException object with exception.

Method Summary

void	finallyLocalize() Finally localizes the LocalizableText message (if there is one attached).
void	finallyLocalize(TimeZone arg0) Finally localizes the LocalizableText message (if there is one attached) with the specified time zone information.
String	getLocalizedMessage() Gets the localized message from BaseExceptionInfo instance.
String	getLocalizedMessage(TimeZone arg0) Returns the localized message string with a time zone restriction.
String	getMessage() Returns the exception message.
String	getNestedLocalizedMessage() Returns the nested localized message.
String	getNestedLocalizedMessage(TimeZone arg0) Returns the nested localized message with time zone information.

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

BIException

public BIException(Locale locale)

Creates an empty collection of messages and constructs a BIException object in which the description defaults to null and the state defaults to null.

Parameters:

locale - Locale for message

BIException

public BIException(Locale locale,
                   String messageId)

Constructs a BIException object with the given description.

Parameters:

locale - Locale for message

messageId - unique ID of a given message

BIException

public BIException(Locale locale,
                   String messageId,
                   Object[] args)

Constructs a BIException object with the given description.

Parameters:

locale - Locale for message

messageId - unique ID of a given message

args - arguments of the formatted message

BIException

public BIException(Locale locale,
                   Throwable cause)

Constructs a BIException object with exception.

Parameters:

locale - Locale for message

cause - the exception that caused to this exception

BIException

public BIException(Locale locale,
                   String messageId,
                   Object[] obj,
                   Throwable cause)

Constructs a BIException object with message ID, message arguments, and original exception.

Parameters:

locale - Locale for message

messageId - unique ID of a given message

obj - argument of the message

cause - the original exception to nest in this exception

BIException

public BIException(Locale locale,
                   String messageId,
                   Throwable cause)

Constructs a BIException with the given description and stores the original exception.

Parameters:

locale - Locale for message

messageId - unique ID of a given message

cause - the original exception to nest in this exception

BIException

public BIException(Locale locale,
                   com.sap.tc.logging.Category category,
                   int severity,
                   com.sap.tc.logging.Location location,
                   String messageId,
                   Throwable cause)

Constructs a BIException object with log handling.

Parameters:

locale - Locale for message

category - category of the exception

severity - severity of the exception

location - the location where this exception is thrown

messageId - unique ID of a given message

cause - the original exception to nest in this exception

BIException

public BIException(Locale locale,
                   com.sap.tc.logging.Category category,
                   int severity,
                   com.sap.tc.logging.Location location,
                   String messageId,
                   Object[] args,
                   Throwable cause)

Constructs a BIException object with log handling.

Parameters:

locale - Locale for message

category - category of the exception

severity - severity of the exception

location - the location where this exception is thrown

messageId - unique ID of a given message

args - arguments of the formatted message

cause - the original exception to nest in this exception

Method Detail

finallyLocalize

public void finallyLocalize()

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

Overrides:

finallyLocalize in class com.sap.exception.BaseException

finallyLocalize

public void finallyLocalize(TimeZone arg0)

Finally localizes the LocalizableText message (if there is one attached) with the specified time zone information.

Overrides:

finallyLocalize in class com.sap.exception.BaseException

getLocalizedMessage

public String getLocalizedMessage()

Gets the localized message from BaseExceptionInfo instance.

Overrides:

getLocalizedMessage in class com.sap.exception.BaseException

See Also:

Throwable.getLocalizedMessage()

getLocalizedMessage

public String getLocalizedMessage(TimeZone arg0)

Returns the localized message string with a time zone restriction.

Overrides:

getLocalizedMessage in class com.sap.exception.BaseException

getMessage

public String getMessage()

Returns the exception message.

Overrides:

getMessage in class com.sap.exception.BaseException

See Also:

Throwable.getMessage()

getNestedLocalizedMessage

public String getNestedLocalizedMessage()

Returns the nested localized message.

Overrides:

getNestedLocalizedMessage in class com.sap.exception.BaseException

getNestedLocalizedMessage

public String getNestedLocalizedMessage(TimeZone arg0)

Returns the nested localized message with time zone information.

Overrides:

getNestedLocalizedMessage in class com.sap.exception.BaseException