SAP BI Java SDK

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

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--javax.resource.ResourceException
                    |
                    +--com.sap.ip.bi.sdk.exception.BIResourceException
All Implemented Interfaces:
com.sap.exception.IBaseException, Serializable

public class BIResourceException
extends javax.resource.ResourceException
implements com.sap.exception.IBaseException

Thrown to indicate a lower-level problem. This is the wrapper for the exception javax.resource.ResourceException.

Since:
3.50
See Also:
Serialized Form

Fields inherited from interface com.sap.exception.IBaseException
audit, defaultLocale
 
Constructor Summary
BIResourceException(Locale locale)
          Constructs a BIResourceException object with no parameter.
BIResourceException(Locale locale, com.sap.tc.logging.Category category, int severity, com.sap.tc.logging.Location location, String messageId, Object[] args, Throwable cause)
          Constructs a BIResourceException object with log handling.
BIResourceException(Locale locale, com.sap.tc.logging.Category category, int severity, com.sap.tc.logging.Location location, String messageId, Throwable cause)
          Constructs a BIResourceException object with log handling.
BIResourceException(Locale locale, String messageId)
          Constructs a BIResourceException object with message ID.
BIResourceException(Locale locale, String messageId, Object[] args)
          Constructs a BIResourceException object with message ID and arguments.
BIResourceException(Locale locale, String messageId, Object[] args, Throwable cause)
          Constructs a BIResourceException object with message ID, arguments, and original exception.
BIResourceException(Locale locale, String messageId, Throwable cause)
          Constructs a BIResourceException object with message ID and original exception.
BIResourceException(Locale locale, Throwable cause)
          Constructs a BIResourceException object with cause parameter.
 
Method Summary
 void finallyLocalize()
          Finally localizes the LocalizableText message (if there is one attached).
 void finallyLocalize(Locale arg0)
          Finally localizes the LocalizableText message (if there is one attached) with the specified locale information.
 void finallyLocalize(Locale loc, TimeZone timeZone)
          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.
 Throwable getCause()
          Returns the cause of the problem.
 com.sap.localization.LocalizableText getLocalizableMessage()
          Gets the LocalizableText class from BaseExceptionInfo instance.
 String getLocalizedMessage()
          Gets the localized message from BaseExceptionInfo instance.
 String getLocalizedMessage(Locale arg0)
          Returns the localized message with a locale as input.
 String getLocalizedMessage(Locale loc, TimeZone timeZone)
          Gets the localized message according to BaseExceptionInfo instance with locale and time zone information.
 String getLocalizedMessage(TimeZone arg0)
          Returns the localized message string with a time zone restriction.
 com.sap.tc.logging.Location getLogLocation()
          Gets logging location.
 int getLogSeverity()
          Gets logging severity.
 String getMessage()
          Returns the exception message.
 String getNestedLocalizedMessage()
          Returns the nested localized message.
 String getNestedLocalizedMessage(Locale arg0)
          Returns nested localized message with locale information.
 String getNestedLocalizedMessage(Locale arg0, TimeZone arg1)
          Returns the nested localized message with locale and time zone information.
 String getNestedLocalizedMessage(TimeZone arg0)
          Returns the nested localized message with time zone information.
 String getNestedStackTraceString()
          Gets the nested stack trace string from BaseExceptionInfo instance.
 String getStackTraceString()
          Gets stack trace information of this exception only.
 String getSystemStackTraceString()
          Gets the stack information of this exception with respect to the current system environment.
 Throwable initCause(Throwable arg0)
          Initializes the cause of this exception to the specified value.
 void log()
          Logs the exception message.
 void printStackTrace()
          Prints this Throwable and its backtrace to the standard error stream.
 void printStackTrace(PrintStream printStream)
          Prints this Throwable and its backtrace to the specified print stream.
 void printStackTrace(PrintWriter printWriter)
          Prints this Throwable and its backtrace to the specified print writer.
 void restoreLogSettings()
          Restores log settings to their original value before setLogSettings(Category, int, Location) has been used.
 void setLogSettings(com.sap.tc.logging.Category arg0, int arg1, com.sap.tc.logging.Location arg2)
          Sets the log settings with the specified category and location information.
 
Methods inherited from class javax.resource.ResourceException
getErrorCode, getLinkedException, setLinkedException
 
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

BIResourceException

public BIResourceException(Locale locale)
Constructs a BIResourceException object with no parameter.
Parameters:
locale - Locale for message

BIResourceException

public BIResourceException(Locale locale,
                           Throwable cause)
Constructs a BIResourceException object with cause parameter.
Parameters:
locale - Locale for message
cause - the original exception to nest in this exception

BIResourceException

public BIResourceException(Locale locale,
                           String messageId)
Constructs a BIResourceException object with message ID.
Parameters:
locale - Locale for message
messageId - unique ID of a given message
See Also:
Throwable.Throwable(String)

BIResourceException

public BIResourceException(Locale locale,
                           String messageId,
                           Object[] args,
                           Throwable cause)
Constructs a BIResourceException object with message ID, arguments, and original exception.
Parameters:
locale - Locale for message
messageId - unique ID of a given message
args - arguments of the formatted message
cause - the original exception to nest in this exception

BIResourceException

public BIResourceException(Locale locale,
                           String messageId,
                           Object[] args)
Constructs a BIResourceException object with message ID and arguments.
Parameters:
locale - Locale for message
messageId - unique ID of a given message
args - arguments of the formatted message

BIResourceException

public BIResourceException(Locale locale,
                           String messageId,
                           Throwable cause)
Constructs a BIResourceException object with message ID and original exception.
Parameters:
locale - Locale for message
messageId - unique ID of a given message
cause - the original exception to nest in this exception

BIResourceException

public BIResourceException(Locale locale,
                           com.sap.tc.logging.Category category,
                           int severity,
                           com.sap.tc.logging.Location location,
                           String messageId,
                           Throwable cause)
Constructs a BIResourceException 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

BIResourceException

public BIResourceException(Locale locale,
                           com.sap.tc.logging.Category category,
                           int severity,
                           com.sap.tc.logging.Location location,
                           String messageId,
                           Object[] args,
                           Throwable cause)
Constructs a BIResourceException 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

getLocalizedMessage

public String getLocalizedMessage()
Gets the localized message from BaseExceptionInfo instance.
Specified by:
getLocalizedMessage in interface com.sap.exception.IBaseException
Overrides:
getLocalizedMessage in class Throwable
See Also:
Throwable.getLocalizedMessage()

getLocalizableMessage

public com.sap.localization.LocalizableText getLocalizableMessage()
Gets the LocalizableText class from BaseExceptionInfo instance.
Specified by:
getLocalizableMessage in interface com.sap.exception.IBaseException

getLocalizedMessage

public String getLocalizedMessage(Locale loc,
                                  TimeZone timeZone)
Gets the localized message according to BaseExceptionInfo instance with locale and time zone information.
Specified by:
getLocalizedMessage in interface com.sap.exception.IBaseException

finallyLocalize

public void finallyLocalize(Locale loc,
                            TimeZone timeZone)
Finally localizes the LocalizableText message (if there is one attached).
Specified by:
finallyLocalize in interface com.sap.exception.IBaseException

getNestedStackTraceString

public String getNestedStackTraceString()
Gets the nested stack trace string from BaseExceptionInfo instance.
Specified by:
getNestedStackTraceString in interface com.sap.exception.IBaseException

getSystemStackTraceString

public String getSystemStackTraceString()
Gets the stack information of this exception with respect to the current system environment.
Specified by:
getSystemStackTraceString in interface com.sap.exception.IBaseException

initCause

public Throwable initCause(Throwable arg0)
Initializes the cause of this exception to the specified value.
Specified by:
initCause in interface com.sap.exception.IBaseException

getCause

public Throwable getCause()
Returns the cause of the problem.
Specified by:
getCause in interface com.sap.exception.IBaseException

getLocalizedMessage

public String getLocalizedMessage(Locale arg0)
Returns the localized message with a locale as input.
Specified by:
getLocalizedMessage in interface com.sap.exception.IBaseException

getLocalizedMessage

public String getLocalizedMessage(TimeZone arg0)
Returns the localized message string with a time zone restriction.
Specified by:
getLocalizedMessage in interface com.sap.exception.IBaseException

getNestedLocalizedMessage

public String getNestedLocalizedMessage()
Returns the nested localized message.
Specified by:
getNestedLocalizedMessage in interface com.sap.exception.IBaseException

getNestedLocalizedMessage

public String getNestedLocalizedMessage(Locale arg0)
Returns nested localized message with locale information.
Specified by:
getNestedLocalizedMessage in interface com.sap.exception.IBaseException

getNestedLocalizedMessage

public String getNestedLocalizedMessage(TimeZone arg0)
Returns the nested localized message with time zone information.
Specified by:
getNestedLocalizedMessage in interface com.sap.exception.IBaseException

getNestedLocalizedMessage

public String getNestedLocalizedMessage(Locale arg0,
                                        TimeZone arg1)
Returns the nested localized message with locale and time zone information.
Specified by:
getNestedLocalizedMessage in interface com.sap.exception.IBaseException

finallyLocalize

public void finallyLocalize()
Finally localizes the LocalizableText message (if there is one attached).
Specified by:
finallyLocalize in interface com.sap.exception.IBaseException

finallyLocalize

public void finallyLocalize(Locale arg0)
Finally localizes the LocalizableText message (if there is one attached) with the specified locale information.
Specified by:
finallyLocalize in interface com.sap.exception.IBaseException

finallyLocalize

public void finallyLocalize(TimeZone arg0)
Finally localizes the LocalizableText message (if there is one attached) with the specified time zone information.
Specified by:
finallyLocalize in interface com.sap.exception.IBaseException

getStackTraceString

public String getStackTraceString()
Gets stack trace information of this exception only.
Specified by:
getStackTraceString in interface com.sap.exception.IBaseException

setLogSettings

public void setLogSettings(com.sap.tc.logging.Category arg0,
                           int arg1,
                           com.sap.tc.logging.Location arg2)
Sets the log settings with the specified category and location information.
Specified by:
setLogSettings in interface com.sap.exception.IBaseException

log

public void log()
Logs the exception message.
Specified by:
log in interface com.sap.exception.IBaseException

getMessage

public String getMessage()
Returns the exception message.
Overrides:
getMessage in class Throwable
See Also:
Throwable.getMessage()

printStackTrace

public void printStackTrace()
Prints this Throwable and its backtrace to the standard error stream.
Specified by:
printStackTrace in interface com.sap.exception.IBaseException
Overrides:
printStackTrace in class Throwable
See Also:
IBaseException.printStackTrace()

printStackTrace

public void printStackTrace(PrintStream printStream)
Prints this Throwable and its backtrace to the specified print stream.
Specified by:
printStackTrace in interface com.sap.exception.IBaseException
Overrides:
printStackTrace in class Throwable
See Also:
IBaseException.printStackTrace(PrintStream)

printStackTrace

public void printStackTrace(PrintWriter printWriter)
Prints this Throwable and its backtrace to the specified print writer.
Specified by:
printStackTrace in interface com.sap.exception.IBaseException
Overrides:
printStackTrace in class Throwable
See Also:
IBaseException.printStackTrace(PrintWriter)

getLogSeverity

public int getLogSeverity()
Gets logging severity. If no severity is specified, Severity.NONE is returned.
Returns:
logging severity

getLogLocation

public com.sap.tc.logging.Location getLogLocation()
Gets logging location. If no location is specified, null is returned.
Returns:
logging location

restoreLogSettings

public void restoreLogSettings()
Restores log settings to their original value before setLogSettings(Category, int, Location) has been used.
See Also:
setLogSettings(Category, int, Location)

SAP BI Java SDK

Copyright © 2004-2006 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.
These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.