SAP BI Java SDK

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

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--java.lang.RuntimeException
                    |
                    +--javax.jmi.reflect.JmiException
                          |
                          +--com.sap.ip.bi.sdk.exception.BIJmiVerifyException
All Implemented Interfaces:
com.sap.exception.IBaseException, Serializable

public class BIJmiVerifyException
extends javax.jmi.reflect.JmiException
implements com.sap.exception.IBaseException

Exception thrown by generated JMI objects of the BI Java SDK. This could happen within the context of a relational or a multidimensional query, if an exception is detected in the implementation of the operations in the generated code.

Since:
3.50
See Also:
Serialized Form

Fields inherited from interface com.sap.exception.IBaseException
audit, defaultLocale
 
Constructor Summary
BIJmiVerifyException(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.
BIJmiVerifyException(Locale locale, String patternKey)
          Constructs an exception with a localizable message.
BIJmiVerifyException(Locale locale, String patternKey, Object[] args)
          Constructs an exception with a localizable message.
BIJmiVerifyException(Locale locale, String patternKey, Object[] args, Throwable cause)
          Constructs an exception with a localizable message and a root cause.
BIJmiVerifyException(Locale locale, String patternKey, Throwable cause)
          Constructs an exception with a localizable message and a root cause.
BIJmiVerifyException(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(Locale loc)
          Finally localizes the LocalizableText message (if there is one attached).
 void finallyLocalize(Locale loc, TimeZone timeZone)
          Finally localizes the LocalizableText message (if there is one attached).
 void finallyLocalize(TimeZone timeZone)
          Finally localizes the LocalizableText message (if there is one attached).
 Throwable getCause()
          Gets the root cause.
 com.sap.localization.LocalizableText getLocalizableMessage()
          Gets the localizable message.
 String getLocalizedMessage()
          Gets the localized message.
 String getLocalizedMessage(Locale loc)
          Gets the localized message.
 String getLocalizedMessage(Locale loc, TimeZone timeZone)
          Gets the localized message.
 String getLocalizedMessage(TimeZone timeZone)
          Gets the localized message.
 com.sap.tc.logging.Category getLogCategory()
          Gets logging category.
 com.sap.tc.logging.Location getLogLocation()
          Gets logging location.
 int getLogSeverity()
          Gets logging severity.
 String getMessage()
          See getLocalizedMessage().
 String getNestedLocalizedMessage()
          Chains localized messages of the nested exceptions.
 String getNestedLocalizedMessage(Locale loc)
          Chains localized messages of the nested exceptions.
 String getNestedLocalizedMessage(Locale loc, TimeZone timeZone)
          Chains localized message of the nested exceptions.
 String getNestedLocalizedMessage(TimeZone timeZone)
          Chains localized message of the nested exceptions.
 String getNestedStackTraceString()
          Chains the stack trace information of nested exceptions.
 String getStackTraceString()
          Gets stack trace information of this exception only.
 String getSystemStackTraceString()
          Gets the stack information of this exception in respect of the current system environment.
 Throwable initCause(Throwable cause)
          Initializes the cause of this exception to the specified value.
 void log()
          Logs the exception message.
 void printStackTrace()
          Prints this exception and its backtrace to the standard error stream.
 void printStackTrace(PrintStream s)
          Prints this exception and its backtrace to the specified print stream.
 void printStackTrace(PrintWriter s)
          Prints the action object and its backtrace to the specified print writer.
 void restoreLogSettings()
          Restores log settings to their original values before setLogSettings(Category, int, Location) has been used.
 void setLogSettings(com.sap.tc.logging.Category cat, int severity, com.sap.tc.logging.Location loc)
          Sets logging information.
 
Methods inherited from class javax.jmi.reflect.JmiException
getElementInError, getObjectInError
 
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

BIJmiVerifyException

public BIJmiVerifyException(Locale locale,
                            Throwable rootCause)
Constructs an exception with the specified root cause of this exception.
Parameters:
rootCause - throwable object that caused this exception
locale - locale with which to localize the message

BIJmiVerifyException

public BIJmiVerifyException(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 that caused this exception

BIJmiVerifyException

public BIJmiVerifyException(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

BIJmiVerifyException

public BIJmiVerifyException(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

BIJmiVerifyException

public BIJmiVerifyException(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

BIJmiVerifyException

public BIJmiVerifyException(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

initCause

public Throwable initCause(Throwable cause)
Initializes the cause of this exception to the specified value. (The cause is the throwable that caused this exception to get thrown.)

This method can be called at most once. This means the cause can be specified only once.

Specified by:
initCause in interface com.sap.exception.IBaseException
Parameters:
cause - the cause (which is saved for later retrieval by the getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
Returns:
a reference to this exception instance
Throws:
IllegalArgumentException - if cause is this throwable. (A throwable cannot be its own cause.)
IllegalStateException - if the cause was already set

getCause

public Throwable getCause()
Gets the root cause.
Specified by:
getCause in interface com.sap.exception.IBaseException
Returns:
throwable object which caused this exception, or null

getLocalizableMessage

public com.sap.localization.LocalizableText getLocalizableMessage()
Gets the localizable message.
Specified by:
getLocalizableMessage in interface com.sap.exception.IBaseException
Returns:
localizable message or null

getLocalizedMessage

public String getLocalizedMessage()
Gets the 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.

Specified by:
getLocalizedMessage in interface com.sap.exception.IBaseException
Overrides:
getLocalizedMessage in class Throwable
Returns:
message string or null

getLocalizedMessage

public String getLocalizedMessage(Locale loc)
Gets the localized message.

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

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

Specified by:
getLocalizedMessage in interface com.sap.exception.IBaseException
Parameters:
loc - locale
Returns:
message string or null

getLocalizedMessage

public String getLocalizedMessage(TimeZone timeZone)
Gets the 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.

Specified by:
getLocalizedMessage in interface com.sap.exception.IBaseException
Parameters:
timeZone - time zone
Returns:
message string or null

getLocalizedMessage

public String getLocalizedMessage(Locale loc,
                                  TimeZone timeZone)
Gets the localized message.

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

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

Specified by:
getLocalizedMessage in interface com.sap.exception.IBaseException
Parameters:
loc - locale
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.

Specified by:
getNestedLocalizedMessage in interface com.sap.exception.IBaseException
Returns:
message string or null

getNestedLocalizedMessage

public String getNestedLocalizedMessage(Locale loc)
Chains localized messages of the nested exceptions.

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

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

Specified by:
getNestedLocalizedMessage in interface com.sap.exception.IBaseException
Parameters:
loc - locale
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).

Specified by:
getNestedLocalizedMessage in interface com.sap.exception.IBaseException
Parameters:
timeZone - time zone
Returns:
message string or null

getNestedLocalizedMessage

public String getNestedLocalizedMessage(Locale loc,
                                        TimeZone timeZone)
Chains localized message of the nested exceptions.

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

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

Specified by:
getNestedLocalizedMessage in interface com.sap.exception.IBaseException
Parameters:
loc - locale
timeZone - time zone
Returns:
message string

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.

Specified by:
finallyLocalize in interface com.sap.exception.IBaseException

finallyLocalize

public void finallyLocalize(Locale loc)
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 locale and the default time zone are used for localization. If the locale parameter is null, the default locale will be used.

Specified by:
finallyLocalize in interface com.sap.exception.IBaseException
Parameters:
loc - locale

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.

Specified by:
finallyLocalize in interface com.sap.exception.IBaseException
Parameters:
timeZone - time zone

finallyLocalize

public void finallyLocalize(Locale loc,
                            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 locale and the specified time zone are used for localization. If the time zone parameter or the locale parameter are null, the default values will be used respectively.

Specified by:
finallyLocalize in interface com.sap.exception.IBaseException
Parameters:
loc - locale
timeZone - time zone

getSystemStackTraceString

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

getStackTraceString

public String getStackTraceString()
Gets stack trace information of this exception only.

The stack traces of nested exceptions are not chained.

Specified by:
getStackTraceString in interface com.sap.exception.IBaseException
Returns:
the stack trace as a string without information of chained exceptions.

getNestedStackTraceString

public String getNestedStackTraceString()
Chains the stack trace information of nested exceptions.

The caused stack trace is displayed first.

Specified by:
getNestedStackTraceString in interface com.sap.exception.IBaseException
Returns:
the stack trace as a string

setLogSettings

public void setLogSettings(com.sap.tc.logging.Category cat,
                           int severity,
                           com.sap.tc.logging.Location loc)
Sets logging information.
Specified by:
setLogSettings in interface com.sap.exception.IBaseException
Parameters:
cat - logging category
severity - logging severity
loc - logging location

log

public void log()
Logs the exception message. The logging takes only place if the category and location are set properly.
Specified by:
log in interface com.sap.exception.IBaseException

printStackTrace

public void printStackTrace()
Prints this exception and its backtrace to the standard error stream. This method prints a stack trace for this exception object on the error output stream that is the value of the field System.err.
Specified by:
printStackTrace in interface com.sap.exception.IBaseException
Overrides:
printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintStream s)
Prints this exception and its backtrace to the specified print stream.
Specified by:
printStackTrace in interface com.sap.exception.IBaseException
Overrides:
printStackTrace in class Throwable
Parameters:
s - PrintStream to use for output

printStackTrace

public void printStackTrace(PrintWriter s)
Prints the action object and its backtrace to the specified print writer.
Specified by:
printStackTrace in interface com.sap.exception.IBaseException
Overrides:
printStackTrace in class Throwable
Parameters:
s - PrintWriter to use for output

getMessage

public String getMessage()
See getLocalizedMessage().
Overrides:
getMessage in class Throwable

getLogCategory

public com.sap.tc.logging.Category getLogCategory()
Gets logging category.

If no category is specified, null is returned.

Returns:
logging category

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 values 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.