oracle.dss.util

Class BIBaseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

oracle.dss.util.BIBaseException

All Implemented Interfaces:

java.io.Serializable, BIException

Direct Known Subclasses:

BIFacesException, DataException, GaugeException, RuleException

public abstract class BIBaseException
extends java.lang.Exception
implements BIException

Indicates a problem somewhere in a BI Beans operation. Subclasses of this class provide specific information about the type of problem that occurred.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected BIExceptionSupport	m_support

Constructor Summary

Constructors

Constructor and Description
BIBaseException(java.lang.String s, java.lang.Throwable prevException) Constructor for an exception that displays a customized message and that passes on an underlying exception.

Method Summary

Modifier and Type	Method and Description
java.lang.Throwable	elementAt(int index) Retrieves the exception at the specified index.
java.util.Enumeration	elements() Retrieves An enumeration of exceptions in the exception chain.
BIException	findException(int nErrorCode) Determines whether the specified error code appears in the BIException exception stack.
java.lang.Throwable	getBIRootCause() Retrieves the root exception.
BIException	getException(java.lang.String strMessage)
java.lang.Throwable	getPreviousException() Retrieves the underlying exception, if one exists.
void	printStackTrace()
void	printStackTrace(java.io.PrintWriter pw)
void	printStackTraceSuper()
void	printStackTraceSuper(java.io.PrintWriter pw)
int	size() Retrieves the size of the exception chain.
java.lang.String	toString() Retrieves the exception stack.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

m_support

protected BIExceptionSupport m_support

For internal use only. Application developers should not use this

Constructor Detail

BIBaseException

public BIBaseException(java.lang.String s,
                       java.lang.Throwable prevException)

Constructor for an exception that displays a customized message and that passes on an underlying exception.

Parameters:

s - The customized message.

prevException - The exception that underlies this exception.

Method Detail

printStackTrace

public void printStackTrace()

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintWriter pw)

Overrides:

printStackTrace in class java.lang.Throwable

printStackTraceSuper

public void printStackTraceSuper(java.io.PrintWriter pw)

For internal use only. Application developers should not use this

printStackTraceSuper

public void printStackTraceSuper()

For internal use only. Application developers should not use this

getPreviousException

public java.lang.Throwable getPreviousException()

Retrieves the underlying exception, if one exists.

Specified by:

getPreviousException in interface BIException

Returns:

The previous exception. If there is no previous exception, then this method returns null.

toString

public java.lang.String toString()

Retrieves the exception stack.

Specified by:

toString in interface BIException

Overrides:

toString in class java.lang.Throwable

Returns:

A concatenation of all messages from exceptions in the exception stack.

getBIRootCause

public java.lang.Throwable getBIRootCause()

Retrieves the root exception.

Specified by:

getBIRootCause in interface BIException

Returns:

the root exception.

elementAt

public java.lang.Throwable elementAt(int index)

Retrieves the exception at the specified index.

Specified by:

elementAt in interface BIException

Returns:

The exception at the specified index.

elements

public java.util.Enumeration elements()

Retrieves An enumeration of exceptions in the exception chain.

Specified by:

elements in interface BIException

Returns:

An enumeration containing the exceptions.

size

public int size()

Retrieves the size of the exception chain.

Specified by:

size in interface BIException

Returns:

The size of the exception chain.

getException

public BIException getException(java.lang.String strMessage)

Parameters:

strMessage - A String which represents the string to find in the BIException.

Returns:

The BIException that is associated with the specified message string, or null.

For internal use only. Application developers should not use this

Determines whether the specified string appears in the BIException stack. This is particularly useful when the string used to create the BIException represents an error code that is used to lookup the associated error string. For example, in the following error, 'DVT-15000' which is represented by the EXC_METADATAMANAGER_NOT_SET literal would represent the error code: DVT-15000 MetadataManager property not set. public static final String EXC_METADATAMANAGER_NOT_SET = "DVT-15000"; BIException biException = getException (EXC_METADATAMANAGER_NOT_SET);

findException

public BIException findException(int nErrorCode)

Determines whether the specified error code appears in the BIException exception stack. For example, if we were looking for a 'DVT-15000 MetadataManager property not set.' exception, we would pass in an error code value of '15000': BIException biException = findException (15000);

Parameters:

nErrorCode - A int which represents the error code to find in the BIException stack.

Returns:

The BIException that is associated with the specified error code, or null.