oracle.express
Class ErrorStack

java.lang.Object
  |
  +--oracle.express.ErrorStack

public final class ErrorStack

extends java.lang.Object

implements HasLocalizedMessage, java.io.Serializable

An object that provides information about an exception that is related to Oracle OLAP execution. Such an exception can be associated with several related errors, and each error is represented in the ErrorStack. The getErrorDescriptions method returns an ErrorDescription for each error on the stack.

In general, the descriptive information that is provided by an ErrorDescription is useful only to Oracle staff who are debugging an internal problem. Typically, it is not meaningful to application developers.

See Also:

ErrorDescription, ExpressServerException.getErrorStack(), Serialized Form

Field Summary

static int	ERROR_CLASS_CORBA_SYSTEM A constant that indicates that the error was in the underlying connection components.
static int	ERROR_CLASS_EXPRESS_FAILURE A constant that indicates that the error was an Oracle OLAP error.
static int	ERROR_CLASS_EXPRESS_FATAL A constant that indicates that the error was a fatal error in Oracle OLAP execution.
static int	ERROR_CLASS_EXPRESS_TERMINATE A constant that indicates that the error was such that the application can do nothing more and that it might as well terminate.
static int	ERROR_CLASS_OLAPI A constant that indicates that the error was in the Oracle OLAP code.
static int	ERROR_CLASS_UNKNOWN_ERROR A constant that indicates that the error had an unknown cause.

Method Summary

int	getErrorClass() Gets the class of error that applies to the first error that was encountered in this ErrorStack.
java.util.List	getErrorDescriptions() Gets a list of ErrorDescription objects, each of which provides information about one error that occurred as part of the exception that has this ErrorStack.
java.lang.String	getLocalizedMessage() Gets a text representation of this ErrorStack, in the default Locale which includes short descriptions for all the errors in the stack.
java.lang.String	getLocalizedMessage(java.util.Locale locale) Gets a text representation of this ErrorStack, in the specified Locale which includes short descriptions for all the errors in the stack.
java.lang.String	toString() Gets a text representation of this ErrorStack, in the default Locale which includes short descriptions for all the errors in the stack.

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_CLASS_OLAPI

public static final int ERROR_CLASS_OLAPI

A constant that indicates that the error was in the Oracle OLAP code.

ERROR_CLASS_CORBA_SYSTEM

public static final int ERROR_CLASS_CORBA_SYSTEM

A constant that indicates that the error was in the underlying connection components.

ERROR_CLASS_UNKNOWN_ERROR

public static final int ERROR_CLASS_UNKNOWN_ERROR

A constant that indicates that the error had an unknown cause.

ERROR_CLASS_EXPRESS_FAILURE

public static final int ERROR_CLASS_EXPRESS_FAILURE

A constant that indicates that the error was an Oracle OLAP error.

ERROR_CLASS_EXPRESS_FATAL

public static final int ERROR_CLASS_EXPRESS_FATAL

A constant that indicates that the error was a fatal error in Oracle OLAP execution.

ERROR_CLASS_EXPRESS_TERMINATE

public static final int ERROR_CLASS_EXPRESS_TERMINATE

A constant that indicates that the error was such that the application can do nothing more and that it might as well terminate.

Method Detail

getErrorDescriptions

public final java.util.List getErrorDescriptions()

Gets a list of ErrorDescription objects, each of which provides information about one error that occurred as part of the exception that has this ErrorStack. A given exception, such as an ExpressServerException, might have several ErrorDescription objects in its ErrorStack, one for the original error and one for each error that was triggered subsequently.

Returns:

A List that contains one ErrorDescription for each error that occurred as part of the exception that has this ErrorStack.

getErrorClass

public final int getErrorClass()

Gets the class of error that applies to the first error that was encountered in this ErrorStack.

Returns:

A constant that indicates the class of error that applies to the first error that was encountered in this ErrorStack. The constant must be one of the ERROR_CLASS fields in this class.

getLocalizedMessage

public java.lang.String getLocalizedMessage(java.util.Locale locale)

Gets a text representation of this ErrorStack, in the specified Locale which includes short descriptions for all the errors in the stack.

Specified by:

getLocalizedMessage in interface HasLocalizedMessage

Parameters:

locale - The Locale to use for translating the message.

Returns:

The message translated for the specified Locale.

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Gets a text representation of this ErrorStack, in the default Locale which includes short descriptions for all the errors in the stack.

Returns:

The message translated for the specified Locale.

toString

public final java.lang.String toString()

Gets a text representation of this ErrorStack, in the default Locale which includes short descriptions for all the errors in the stack.

Overrides:

toString in class java.lang.Object

Returns:

The message translated for the specified Locale.