java.lang.Object | +--CommandException | +--com.ibm.commerce.exception.ECException
ECException is the abstract base class used for defining exceptions thrown by the WebSphere Commerce Application Server.
Field Summary | |
---|---|
static java.lang.String |
APPLICATION_ERROR Default value of the application error parameter. |
static java.lang.String |
ECMESSAGE Default value of the message parameter. |
static java.lang.String |
ECMESSAGEKEY Default value of the message key parameter. |
protected
TypedProperty |
errorProperties |
static java.lang.String |
EXCEP_DATA Default value of the exception data parameter. |
static java.lang.String |
EXCEP_TYPE Default value of the exception type parameter. |
static java.lang.String |
EXCEPTION Default value of the exception parameter. |
static java.lang.String |
GENERIC_APPLICATION_ERROR_TASK Default value of the generic application error task parameter. |
static java.lang.String |
GENERIC_SYSTEM_ERROR_TASK Default value of the generic application error task parameter. |
static java.lang.String |
MSG_PARAM Default value of the message parameter. |
static java.lang.String |
SYSTEM_ERROR Default value of the system error task parameter. |
Constructor Summary | |
---|---|
ECException() Constructor for ECException with an ECMessage object. | |
ECException(ECMessage msg) Constructor for ECException with an ECMessage object. | |
ECException(ECMessage msg,
java.lang.String className, java.lang.String methodName,
java.lang.Object[] msgParam) Constructor for ECApplicationException with an ECMessage object. | |
ECException(ECMessage msg,
java.lang.String className, java.lang.String methodName,
java.lang.Object[] msgParam, boolean logMessage) Constructor for ECApplicationException with an ECMessage object. | |
ECException(ECMessage msg,
java.lang.String className, java.lang.String methodName,
java.lang.Object[] msgParam, java.lang.String errorTaskName) Constructor for ECApplicationException with an ECMessage object. | |
ECException(ECMessage msg,
java.lang.String className, java.lang.String methodName,
java.lang.Object[] msgParam, java.lang.String errorTaskName,
boolean logMsg) Constructor for ECApplicationException with an ECMessage object. | |
ECException(ECMessage msg,
java.lang.String className, java.lang.String methodName,
java.lang.String errorTaskName) Constructor for ECApplicationException with an ECMessage object. | |
ECException(ECMessage msg,
java.lang.String className, java.lang.String methodName,
java.lang.String errorTaskName, boolean logMessage) Constructs for ECApplicationException with an ECMessage object. | |
ECException(java.lang.String message) Constructor for ECException with an ECMessage object. |
Method Summary | |
---|---|
java.lang.String |
getErrorMessageKey() Gets the error message key. |
TypedProperty |
getErrorProperties() Gets the sets of error parameters. |
java.lang.String |
getErrorTaskName() Gets the error task name. |
abstract
java.lang.String |
getErrorType() Gets the type of error. |
abstract
java.lang.String |
getGenericErrorTask() Gets the generic error task |
java.lang.String |
getMessageKey() Gets the error message key. |
static java.lang.String |
getStackTrace(java.lang.Throwable exc) Gets the Stack Trace as a String. |
java.lang.Throwable |
getThrowable() Gets the ECException object associated with this exception. |
java.lang.String |
getUserMessage(java.util.Locale loc) Gets the user message. |
protected
void |
logMessage(ECMessage msg,
java.lang.String className, java.lang.String methodName) Logs a message. |
protected
void |
logMessage(ECMessage msg,
java.lang.String className, java.lang.String methodName,
java.lang.Object[] msgParam) Logs a message. |
protected
void |
logMessage(ECMessage msg,
java.lang.String className, java.lang.String methodName,
java.lang.Object[] msgParam, java.lang.Throwable throwable) Log a message. |
void |
setErrorTaskName(java.lang.String viewtask) Sets the error view task name for this exception. |
void |
setException(java.lang.Throwable exc) Sets the Exception object associated with this exception. |
void |
setOrginatingCommand(java.lang.String value) Sets the name of the command which throws this exception. |
void |
setThrowable(java.lang.Throwable exc) Sets the Exception object associated with this exception. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String GENERIC_APPLICATION_ERROR_TASK
public static final java.lang.String GENERIC_SYSTEM_ERROR_TASK
public static final java.lang.String EXCEP_TYPE
public static final java.lang.String EXCEP_DATA
public static final java.lang.String MSG_PARAM
public static final java.lang.String ECMESSAGE
public static final java.lang.String ECMESSAGEKEY
public static final java.lang.String EXCEPTION
public static final java.lang.String APPLICATION_ERROR
public static final java.lang.String SYSTEM_ERROR
protected TypedProperty errorProperties
Constructor Detail |
---|
public ECException()
public ECException(ECMessage msg)
msg
- the ECMessage object used for describing the
exceptionpublic ECException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam)
msg
- the ECMessage object used for describing the
exceptionclassName
- the name of the class that threw this
ECApplicationExceptionmethodName
- the name of the method that threw this
ECApplicationExceptionmsgParam
- an array of parameter values to be passed to the
messagepublic ECException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, java.lang.String errorTaskName)
msg
- the ECMessage object used for describing the
exceptionclassName
- the name of the class that threw this
ECApplicationExceptionmethodName
- the name of the method that threw this
ECApplicationExceptionmsgParam
- an array of parameter values to be passed to the
messageerrorTaskName
- the name of the exception handler to handle
this messagepublic ECException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.String errorTaskName)
msg
- the ECMessage object used for describing the
exceptionclassName
- the name of the class that threw this
ECApplicationExceptionmethodName
- the name of the method that threw this
ECApplicationExceptionerrorTaskName
- the name of the exception handler to handle
this messagepublic ECException(java.lang.String message)
message
- the string used for describing the
exceptionpublic ECException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, boolean logMessage)
msg
- the ECMessage object used for describing the
exceptionclassName
- the name of the class that threw this
ECApplicationExceptionmethodName
- the name of the method that threw this
ECApplicationExceptionmsgParam
- an array of parameter values to be passed to the
messagelogMessage
- true if an error message is logged
immediatelypublic ECException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, java.lang.String errorTaskName, boolean logMsg)
msg
- the ECMessage object used for describing the
exceptionclassName
- the name of the class that threw this
ECApplicationExceptionmethodName
- the name of the method that threw this
ECApplicationExceptionmsgParam
- an array of parameter values to be passed to the
messageerrorTaskName
- the name of the exception handler to handle
this messagepublic ECException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.String errorTaskName, boolean logMessage)
msg
- the ECMessage object used for describing the
exceptionclassName
- the name of the class that threw this
ECApplicationExceptionmethodName
- the name of the method that threw this
ECApplicationExceptionerrorTaskName
- the name of the exception handler to handle
this messagelogMessage
- true if an error message is logged
immediatelyMethod Detail |
---|
public java.lang.String getErrorMessageKey()
public TypedProperty getErrorProperties()
public java.lang.String getErrorTaskName()
public abstract java.lang.String getErrorType()
public abstract java.lang.String getGenericErrorTask()
public java.lang.String getMessageKey()
public static java.lang.String getStackTrace(java.lang.Throwable exc)
exc
- the Throwable objectpublic java.lang.Throwable getThrowable()
public java.lang.String getUserMessage(java.util.Locale loc)
protected void logMessage(ECMessage msg, java.lang.String className, java.lang.String methodName)
msg
- the ECMessage object used for describing the
exceptionclassName
- the name of the class that threw this
ECExceptionmethodName
- the name of the method that threw this
ECExceptionprotected void logMessage(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam)
msg
- the ECMessage object used for describing the
exceptionclassName
- the name of the class that threw this
ECExceptionmethodName
- the name of the method that threw this
ECExceptionmsgParam
- array of object to be passed as parameters to the
messageprotected void logMessage(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, java.lang.Throwable throwable)
msg
- the ECMessage object used for describing the
exceptionclassName
- the name of the class that threw this
ECExceptionmethodName
- the name of the method that threw this
ECExceptionmsgParam
- array of object to be passed as parameters to the
messagethrowable
- the Throwable objectpublic void setErrorTaskName(java.lang.String viewtask)
viewtask
- name of the error view taskpublic void setException(java.lang.Throwable exc)
exc
- the Throwable objectpublic void setOrginatingCommand(java.lang.String value)
value
- The name of the command.public void setThrowable(java.lang.Throwable exc)
exc
- The Throwable object.