com.sonicsw.xq
Class XQException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.sonicsw.xq.XQException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

XQAccessorException, XQAddressNotFoundException, XQDispatchException, XQEndpointException, XQMessageException, XQServiceException

public abstract class XQException
extends java.lang.Exception

This is the root class of all SonicXQ API exceptions.

It provides the following information:

• A reason string describing the error. This string is the standard exception message and is available via the getMessage method.
• An integer error code
• A reference to another exception. Often a SonicXQ API exception will be the result of a lower-level problem. If appropriate, this lower-level exception can be linked to the SonicXQ API exception.

See Also:

Serialized Form

Field Summary

static int

UNSPECIFIED Indicates an unspecified error code.

Method Summary

int	getErrorID() Gets the exception's error code.
java.lang.Throwable	getLinkedException() Gets the exception linked to this one.
java.lang.String	getLocalizedMessage() Get the localized error message.
java.lang.String	getMessage() Gets the error message.
void	setErrorID(int errorID) Sets an error code.
void	setLinkedException(java.lang.Throwable exception) Sets a linked exception.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

UNSPECIFIED

public static final int UNSPECIFIED

Indicates an unspecified error code.

See Also:

Constant Field Values

Method Detail

setLinkedException

public final void setLinkedException(java.lang.Throwable exception)

Sets a linked exception.

Parameters:

exception - The linked exception.

getLinkedException

public final java.lang.Throwable getLinkedException()

Gets the exception linked to this one.

Returns:

The linked exception.

setErrorID

public final void setErrorID(int errorID)

Sets an error code.

Parameters:

errorID - The error code.

getErrorID

public final int getErrorID()

Gets the exception's error code.

Returns:

errorID The error code.

getMessage

public java.lang.String getMessage()

Gets the error message.

Overrides:

getMessage in class java.lang.Throwable

Returns:

The exception's message, the linked exception's message, or null.

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Get the localized error message.

Overrides:

getLocalizedMessage in class java.lang.Throwable

Returns:

The localized exception's message, the localized linked exception's message, or null.