com.ibm.retail.si.util
Class AEFException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.ibm.retail.si.util.AEFException
All Implemented Interfaces:
java.io.Serializable

public class AEFException
extends java.lang.Exception

Encapsulates a throwable Exception in the Store Integrator.

See Also:
Serialized Form

Field Summary
protected  int errorCode
           
protected  int errorCodeExtended
           
protected  java.lang.String errorKey
           
protected  com.ibm.retail.si.util.AEFError errorObject
           
protected  com.ibm.retail.si.util.AEFException nextException
           
protected  java.lang.Throwable originalThrowable
           
protected  com.ibm.retail.si.util.AEFException previousException
           
 
Fields inherited from class java.lang.Exception
 
Constructor Summary
AEFException(int errorCode)
          Construct an AEFException with an error code
AEFException(int errorCode, int errorCodeExtended)
          Construct an AEFException with an error code and extended error code.
AEFException(int errorCode, int errorCodeExtended, com.ibm.retail.si.util.AEFException origException)
          Construct an AEFException with an error code and description as a wrapper for an original exception.
AEFException(int errorCode, int errorCodeExtended, java.lang.String description)
          Construct an AEFException with an error code, extended error code, and error description.
AEFException(int errorCode, int errorCodeExtended, java.lang.String description, com.ibm.retail.si.util.AEFException origException)
          Construct an AEFException with an error code, extended error code, and error description which is a wrapper for an original Exception.
AEFException(int errorCode, int errorCodeExtended, java.lang.String description, com.ibm.retail.si.util.AEFException origException, java.lang.String theErrorKey)
          Construct an AEFException with an error code, extended error code, and error description which is a wrapper for an original Exception.
AEFException(int errorCode, int errorCodeExtended, java.lang.String description, java.lang.String theErrorKey)
          Construct an AEFException with an error code, extended error code, and error description which is a wrapper for an original Exception.
AEFException(int errorCode, int errorCodeExtended, java.lang.String description, java.lang.Throwable origException)
          Construct an AEFException with an error code, extended error code, and error description which is a wrapper for an original Exception.
AEFException(int errorCode, int errorCodeExtended, java.lang.String description, java.lang.Throwable origException, java.lang.String theErrorKey)
          Construct an AEFException with an error code, extended error code, and error description which is a wrapper for an original Exception.
AEFException(int errorCode, int errorCodeExtended, java.lang.Throwable origException)
          Construct an AEFException with an error code and description as a wrapper for an original exception.
AEFException(int errorCode, java.lang.String description)
          Construct an AEFException with an error code and error description.
AEFException(java.lang.String description, com.ibm.retail.si.util.AEFError errorObjectAEF)
          Construct an AEFException with an error code, extended error code, and error description which is a wrapper for an original Exception.
AEFException(java.lang.String description, com.ibm.retail.si.util.AEFException origException, com.ibm.retail.si.util.AEFError errorObjectAEF)
          Construct an AEFException with an error code, extended error code, and error description which is a wrapper for an original Exception.
AEFException(java.lang.String description, java.lang.Throwable origException, com.ibm.retail.si.util.AEFError errorObjectAEF)
          Construct an AEFException with an error code, extended error code, and error description which is a wrapper for an original Exception.
 
Method Summary
 void appendExceptions(com.ibm.retail.si.util.AEFException exceptionsToAppend)
          This method takes an AEFException and sets the Previous Exception attribute for the last AEFException object on this list (the object that we called the method on) to point to it.
(package private) static java.lang.String copyright()
           
 java.lang.String getAEFExceptionText(com.ibm.retail.si.util.AEFException currentAEFException, int indentLevel)
          This method will return the information for this AEFException as a String.
 java.lang.String getDescription()
          Returns the description for the exception.
 int getErrorCode()
          Returns the error code for the exception.
 int getErrorCodeExtended()
          Returns the extended error code for the exception.
 java.lang.String getErrorKey()
          Returns the AEFErrorKey for this exception.
 com.ibm.retail.si.util.AEFError getErrorObject()
          Gets the AEF error object for this exception.
 com.ibm.retail.si.util.AEFException getNextException()
          Gets the next AEFException on the list of chained exceptions.
 com.ibm.retail.si.util.AEFException getOriginalException()
          Gets the original AEFException (last in the chain) on the list of chained exceptions.
 java.lang.Throwable getOriginalThrowable()
          Gets the original throwable (the cause in JVM 1.4 >) for this exception.
 com.ibm.retail.si.util.AEFException getPreviousException()
          Gets the previous AEFException on the list of chained exceptions.
 java.lang.String getStackText(java.lang.Throwable currentThrowable, int indentLevel)
          This method will return the stack trace for a throwable as a String.
 void printExceptions()
          This method will print all the exceptions in the chain starting with this exception.
 void setErrorCode(int newErrorCode)
          Set the error code for this exception.
 void setErrorKey(java.lang.String newErrorKey)
          Sets the Exception object imbedded within this exception.
 void setErrorObject(com.ibm.retail.si.util.AEFError newErrorObject)
          Set the AEF error object for this exception.
 void setExtendedErrorCode(int newErrorCode)
          Set the extended error code for this exception.
 void setNextException(com.ibm.retail.si.util.AEFException newNextException)
          Set the next AEFException on the list of chained exceptions.
 void setOriginalThrowable(java.lang.Throwable newOriginalThrowable)
          Set the original throwable (the cause in JVM 1.4 >) for this exception.
 void setPreviousException(com.ibm.retail.si.util.AEFException prevException)
          Set the previous AEFException on the list of chained exceptions.
 java.lang.String toString()
          This method will print a summary of the exceptions.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

errorCode

protected int errorCode

errorCodeExtended

protected int errorCodeExtended

errorKey

protected java.lang.String errorKey

originalThrowable

protected java.lang.Throwable originalThrowable

previousException

protected com.ibm.retail.si.util.AEFException previousException

nextException

protected com.ibm.retail.si.util.AEFException nextException

errorObject

protected com.ibm.retail.si.util.AEFError errorObject
Constructor Detail

AEFException

public AEFException(int errorCode)
Construct an AEFException with an error code

Parameters:
errorCode - The error code

AEFException

public AEFException(int errorCode,
                    int errorCodeExtended)
Construct an AEFException with an error code and extended error code.

Parameters:
errorCode - The error code
errorCodeExtended - An addition extended error code

AEFException

public AEFException(int errorCode,
                    java.lang.String description)
Construct an AEFException with an error code and error description.

Parameters:
errorCode - The error code.
description - A textual description of the error.

AEFException

public AEFException(int errorCode,
                    int errorCodeExtended,
                    java.lang.String description)
Construct an AEFException with an error code, extended error code, and error description.

Parameters:
errorCode - The error code.
errorCodeExtended - Additional error code.
description - A textual description of the error.

AEFException

public AEFException(int errorCode,
                    int errorCodeExtended,
                    java.lang.Throwable origException)
Construct an AEFException with an error code and description as a wrapper for an original exception.

Parameters:
errorCode - The error code.
origException - The orignal Exception.

AEFException

public AEFException(int errorCode,
                    int errorCodeExtended,
                    java.lang.String description,
                    java.lang.Throwable origException)
Construct an AEFException with an error code, extended error code, and error description which is a wrapper for an original Exception.

Parameters:
errorCode - The error code.
errorCodeExtended - Additional error code.
description - A textual description of the error.
origException - The orignal Exception.

AEFException

public AEFException(int errorCode,
                    int errorCodeExtended,
                    java.lang.String description,
                    java.lang.Throwable origException,
                    java.lang.String theErrorKey)
Construct an AEFException with an error code, extended error code, and error description which is a wrapper for an original Exception.

Parameters:
errorCode - The error code.
errorCodeExtended - Additional error code.
description - A textual description of the error.
origException - The orignal Exception.
theErrorKey - The AEFError key for this error.

AEFException

public AEFException(int errorCode,
                    int errorCodeExtended,
                    com.ibm.retail.si.util.AEFException origException)
Construct an AEFException with an error code and description as a wrapper for an original exception.

Parameters:
errorCode - The error code.
origException - The orignal Exception.

AEFException

public AEFException(int errorCode,
                    int errorCodeExtended,
                    java.lang.String description,
                    com.ibm.retail.si.util.AEFException origException)
Construct an AEFException with an error code, extended error code, and error description which is a wrapper for an original Exception.

Parameters:
errorCode - The error code.
errorCodeExtended - Additional error code.
description - A textual description of the error.
origException - The orignal Exception.

AEFException

public AEFException(int errorCode,
                    int errorCodeExtended,
                    java.lang.String description,
                    com.ibm.retail.si.util.AEFException origException,
                    java.lang.String theErrorKey)
Construct an AEFException with an error code, extended error code, and error description which is a wrapper for an original Exception.

Parameters:
errorCode - The error code.
errorCodeExtended - Additional error code.
description - A textual description of the error.
origException - The orignal Exception.
theErrorKey - The AEFError key for this error.

AEFException

public AEFException(int errorCode,
                    int errorCodeExtended,
                    java.lang.String description,
                    java.lang.String theErrorKey)
Construct an AEFException with an error code, extended error code, and error description which is a wrapper for an original Exception.

Parameters:
errorCode - The error code.
errorCodeExtended - Additional error code.
description - A textual description of the error.
theErrorKey - The AEFError key for this error.

AEFException

public AEFException(java.lang.String description,
                    java.lang.Throwable origException,
                    com.ibm.retail.si.util.AEFError errorObjectAEF)
Construct an AEFException with an error code, extended error code, and error description which is a wrapper for an original Exception.

Parameters:
description - A textual description of the error.
origException - The orignal Exception.

AEFException

public AEFException(java.lang.String description,
                    com.ibm.retail.si.util.AEFException origException,
                    com.ibm.retail.si.util.AEFError errorObjectAEF)
Construct an AEFException with an error code, extended error code, and error description which is a wrapper for an original Exception.

Parameters:
description - A textual description of the error.
origException - The orignal Exception.

AEFException

public AEFException(java.lang.String description,
                    com.ibm.retail.si.util.AEFError errorObjectAEF)
Construct an AEFException with an error code, extended error code, and error description which is a wrapper for an original Exception.

Parameters:
description - A textual description of the error.
Method Detail

copyright

static java.lang.String copyright()

getErrorCode

public int getErrorCode()
Returns the error code for the exception.

Returns:
int The error code.

getErrorCodeExtended

public int getErrorCodeExtended()
Returns the extended error code for the exception.

Returns:
int The extended error code.

getDescription

public java.lang.String getDescription()
Returns the description for the exception.

Returns:
String The exception description.

getErrorKey

public java.lang.String getErrorKey()
Returns the AEFErrorKey for this exception.

Returns:
String The AEFErrorKey for this exception.

setErrorKey

public void setErrorKey(java.lang.String newErrorKey)
Sets the Exception object imbedded within this exception.

Parameters:
newErrorKey - The AEFErrorKey for this exception.

getPreviousException

public com.ibm.retail.si.util.AEFException getPreviousException()
Gets the previous AEFException on the list of chained exceptions.

Returns:
AEFException The previous AEFException on the list of chained exception.

setPreviousException

public void setPreviousException(com.ibm.retail.si.util.AEFException prevException)
Set the previous AEFException on the list of chained exceptions.

Parameters:
prevException - The AEFException to make the next exception on the list.

getNextException

public com.ibm.retail.si.util.AEFException getNextException()
Gets the next AEFException on the list of chained exceptions.

Returns:
AEFException The next AEFException on the list of chained exception.

setNextException

public void setNextException(com.ibm.retail.si.util.AEFException newNextException)
Set the next AEFException on the list of chained exceptions.

Parameters:
newNextException - The AEFException to make the next exception on the list.

getOriginalThrowable

public java.lang.Throwable getOriginalThrowable()
Gets the original throwable (the cause in JVM 1.4 >) for this exception.

Returns:
Throwable The riginal throwable (the cause in JVM 1.4 >) for this exception.

setOriginalThrowable

public void setOriginalThrowable(java.lang.Throwable newOriginalThrowable)
Set the original throwable (the cause in JVM 1.4 >) for this exception.

Parameters:
newOriginalThrowable - The original throwable (the cause in JVM 1.4 >) for this exception.

setErrorCode

public void setErrorCode(int newErrorCode)
Set the error code for this exception.

Parameters:
newErrorCode - The new error code.

setExtendedErrorCode

public void setExtendedErrorCode(int newErrorCode)
Set the extended error code for this exception.

Parameters:
newErrorCode - The new extended error code.

appendExceptions

public void appendExceptions(com.ibm.retail.si.util.AEFException exceptionsToAppend)
This method takes an AEFException and sets the Previous Exception attribute for the last AEFException object on this list (the object that we called the method on) to point to it. The idea is to have this (the object that we called the method on) object (the newest exception) be a the start of the list of exception. Traversing the list of Previous Exception attributes would lead you back in time until the oldest exception in the chain is reached.

Parameters:
exceptionsToAppend - The list of AEFException to append to this list.

printExceptions

public void printExceptions()
This method will print all the exceptions in the chain starting with this exception.


getStackText

public java.lang.String getStackText(java.lang.Throwable currentThrowable,
                                     int indentLevel)
This method will return the stack trace for a throwable as a String.


getAEFExceptionText

public java.lang.String getAEFExceptionText(com.ibm.retail.si.util.AEFException currentAEFException,
                                            int indentLevel)
This method will return the information for this AEFException as a String.


toString

public java.lang.String toString()
This method will print a summary of the exceptions.

Overrides:
toString in class java.lang.Throwable
Returns:
String A summary of all the exceptions on the list.

getOriginalException

public com.ibm.retail.si.util.AEFException getOriginalException()
Gets the original AEFException (last in the chain) on the list of chained exceptions.

Returns:
AEFException The last AEFException on the list of chained exception.

setErrorObject

public void setErrorObject(com.ibm.retail.si.util.AEFError newErrorObject)
Set the AEF error object for this exception.


getErrorObject

public com.ibm.retail.si.util.AEFError getErrorObject()
Gets the AEF error object for this exception.

Returns:
Throwable The AEF error object for this exception.


Copyright © 2004 IBM. All Rights Reserved.
Generated: July 19 2004