com.businessobjects.customds.ui.exception
Class CDSExtensionException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.businessobjects.customds.ui.exception.CDSExtensionException

All Implemented Interfaces:

java.io.Serializable

public class CDSExtensionException
extends java.lang.Exception

CDSExtensionException is an exception class that the plug-in uses for all handled exceptions, to enable the Framework to display localized messages to the user and append exception messages in the Framework's or product's log.

NOTE: The Framework displays error messages only for a few methods. For example, the Framework displays an error message when the client extension throws an exception while trying to retrieve the user interface component.

Since:

12.2

See Also:

Serialized Form

Constructor Summary

CDSExtensionException(java.lang.String logMsg, java.lang.String displayMsg)
Class Constructor

CDSExtensionException(java.lang.Throwable t, java.lang.String logMsg, java.lang.String displayMsg)
Class Constructor

Method Summary

java.lang.Throwable	getCause() Returns the cause of CDSExtensionException or null, if the cause is unknown.
java.lang.String	getDisplayMessage() Internal Use Only
java.lang.Throwable	getException() Returns the CDSExtensionException as a Throwable object.
java.lang.String	getMessage() Internal Use Only
java.lang.String	getMessage(boolean withStack) Internal Use Only
java.lang.String	getStackTraceAsString() Internal Use Only
java.lang.String	toString() Internal Use Only

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CDSExtensionException

public CDSExtensionException(java.lang.String logMsg,
                             java.lang.String displayMsg)

Class Constructor

Parameters:

logMsg - The exception message that must be logged.

displayMsg - The exception message that must be displayed to the user.

CDSExtensionException

public CDSExtensionException(java.lang.Throwable t,
                             java.lang.String logMsg,
                             java.lang.String displayMsg)

Class Constructor

Parameters:

t - The java.lang.Throwable object for obtaining the stack trace.

logMsg - The exception message.

displayMsg - The exception message that must be displayed to the user.

Method Detail

getException

public java.lang.Throwable getException()

Returns the CDSExtensionException as a Throwable object.

This method enables you to retrieve the Throwable object that is used to create CDSExtensionException.

Returns:

The Throwable object that is used to create the CDSExtensionException object, or CDSExtensionException as a Throwable object.

getCause

public java.lang.Throwable getCause()

Returns the cause of CDSExtensionException or null, if the cause is unknown. This method returns the cause that was supplied by one of the constructors that contains a Throwable object, or by the initCause(Throwable) method.

Overrides:

getCause in class java.lang.Throwable

Returns:

The cause of CDSExtensionException or null, if the cause is unknown.

getMessage

public java.lang.String getMessage(boolean withStack)

Internal Use Only

getMessage

public java.lang.String getMessage()

Internal Use Only

Overrides:

getMessage in class java.lang.Throwable

See Also:

Throwable.getMessage()

getDisplayMessage

public java.lang.String getDisplayMessage()

Internal Use Only

toString

public java.lang.String toString()

Internal Use Only

Overrides:

toString in class java.lang.Throwable

getStackTraceAsString

public java.lang.String getStackTraceAsString()

Internal Use Only