ibi.broker.api.data
Class CasterException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          javax.resource.ResourceException
              ibi.broker.api.data.CasterException

All Implemented Interfaces:

java.io.Serializable

public class CasterException
extends javax.resource.ResourceException

CasterException is a generic exception class, which encapsulates the majority of error conditions that can occur within ReportCaster. This exception class extends Java's Resource Exception, which is the root interface of the exception hierarchy defined for the Java Connector Architecture (JCA).

Version:

5.3

See Also:

Serialized Form

Constructor Summary

CasterException(java.lang.String message)

CasterException(java.lang.String errorCode, java.lang.String message)

CasterException(java.lang.String errorCode, java.lang.String message, java.lang.Object[] argumentList)

CasterException(java.lang.String errorCode, java.lang.String message, java.lang.String propertyName)

CasterException(java.lang.String errorCode, java.lang.String message, java.lang.Throwable nestedThrowable)

Method Summary

java.lang.Object[]	getArgumentList()
java.lang.String	getErrorCode() Obtains the error code for this CasterException.
java.lang.String	getMessage() Obtains the message text which describes this CasterException.
java.lang.Throwable	getNestedThrowable() Obtains the error that was the ultimate cause of this CasterException.
java.lang.String	getPropertyName() Obtains the name of the property associated with the class in which this CasterException was thrown.
void	setArgumentList(java.lang.Object[] argumentList)
java.lang.String	toString() Obtains the string concatenation of the error code and the error message thrown by this CasterException.

Methods inherited from class javax.resource.ResourceException

getLinkedException, setErrorCode, setLinkedException

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CasterException

public CasterException(java.lang.String message)

CasterException

public CasterException(java.lang.String errorCode,
                       java.lang.String message)

CasterException

public CasterException(java.lang.String errorCode,
                       java.lang.String message,
                       java.lang.String propertyName)

CasterException

public CasterException(java.lang.String errorCode,
                       java.lang.String message,
                       java.lang.Object[] argumentList)

CasterException

public CasterException(java.lang.String errorCode,
                       java.lang.String message,
                       java.lang.Throwable nestedThrowable)

Method Detail

getErrorCode

public java.lang.String getErrorCode()

Obtains the error code for this CasterException. The error code is a String that provides a brief description of this exception.

Overrides:

getErrorCode in class javax.resource.ResourceException

Returns:

The errorCode as a String.

getMessage

public java.lang.String getMessage()

Obtains the message text which describes this CasterException. The message is a String that provides a full detailed description of this exception.

Overrides:

getMessage in class javax.resource.ResourceException

Returns:

Detailed message as a String.

getNestedThrowable

public java.lang.Throwable getNestedThrowable()

Obtains the error that was the ultimate cause of this CasterException. This will be null if there is no nested Throwable. (i.e., this is the originating exception).

Returns:

The Throwable object that is the originating error.

getPropertyName

public java.lang.String getPropertyName()

Obtains the name of the property associated with the class in which this CasterException was thrown.

Returns:

The propertyName as a String.

toString

public java.lang.String toString()

Obtains the string concatenation of the error code and the error message thrown by this CasterException.

Overrides:

toString in class java.lang.Throwable

Returns:

The combination of the error code and the error message strings.

getArgumentList

public java.lang.Object[] getArgumentList()

setArgumentList

public void setArgumentList(java.lang.Object[] argumentList)