|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
|
static java.lang.String |
ECMESSAGE
|
static java.lang.String |
ECMESSAGEKEY
|
protected TypedProperty |
errorProperties
|
static java.lang.String |
EXCEP_DATA
|
static java.lang.String |
EXCEP_TYPE
|
static java.lang.String |
EXCEPTION
|
static java.lang.String |
GENERIC_APPLICATION_ERROR_TASK
|
static java.lang.String |
GENERIC_SYSTEM_ERROR_TASK
|
static java.lang.String |
MSG_PARAM
|
static java.lang.String |
SYSTEM_ERROR
|
Constructor Summary | |
ECException()
Constructs an ECException with an ECMessage object. |
|
ECException(ECMessage msg)
Constructs an ECException with an ECMessage object. |
|
ECException(ECMessage msg,
java.lang.String className,
java.lang.String methodName,
java.lang.Object[] msgParam)
Constructs an ECApplicationException with an ECMessage object. |
|
ECException(ECMessage msg,
java.lang.String className,
java.lang.String methodName,
java.lang.Object[] msgParam,
boolean logMessage)
Constructs an ECApplicationException with an ECMessage object. |
|
ECException(ECMessage msg,
java.lang.String className,
java.lang.String methodName,
java.lang.Object[] msgParam,
java.lang.String errorTaskName)
Constructs an 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)
Constructs an ECApplicationException with an ECMessage object. |
|
ECException(ECMessage msg,
java.lang.String className,
java.lang.String methodName,
java.lang.String errorTaskName)
Constructs an ECApplicationException with an ECMessage object. |
|
ECException(ECMessage msg,
java.lang.String className,
java.lang.String methodName,
java.lang.String errorTaskName,
boolean logMessage)
Constructs an ECApplicationException with an ECMessage object. |
|
ECException(java.lang.String message)
Constructs an 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)
Return 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)
Method to log a message |
protected void |
logMessage(ECMessage msg,
java.lang.String className,
java.lang.String methodName,
java.lang.Object[] msgParam)
Method to log a message |
protected void |
logMessage(ECMessage msg,
java.lang.String className,
java.lang.String methodName,
java.lang.Object[] msgParam,
java.lang.Throwable throwable)
Method to 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. |
Field Detail |
public static final java.lang.String APPLICATION_ERROR
public static final java.lang.String ECMESSAGE
public static final java.lang.String ECMESSAGEKEY
protected TypedProperty errorProperties
public static final java.lang.String EXCEP_DATA
public static final java.lang.String EXCEP_TYPE
public static final java.lang.String EXCEPTION
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 MSG_PARAM
public static final java.lang.String SYSTEM_ERROR
Constructor Detail |
public ECException()
public ECException(ECMessage msg)
msg
- The ECMessage object used for describing the exception.public ECException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam)
msg
- ECMessage - The ECMessage object used for describing the exception.className
- String - The name of the class that threw this ECApplicationException.methodName
- String - The name of the method that threw this ECApplicationException.msgParam
- Object[] - An array of parameter values to be passed to the message.public ECException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, boolean logMessage)
msg
- ECMessage - The ECMessage object used for describing the exception.className
- String - The name of the class that threw this ECApplicationException.methodName
- String - The name of the method that threw this ECApplicationException.msgParam
- Object[] - An array of parameter values to be passed to the message.logMessage
- boolean - indicate that 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)
msg
- ECMessage - The ECMessage object used for describing the exception.className
- String - The name of the class that threw this ECApplicationException.methodName
- String - The name of the method that threw this ECApplicationException.msgParam
- Object[] - An array of parameter values to be passed to the message.errorTaskName
- String - The name of the exception handler to handle this message.public ECException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, java.lang.String errorTaskName, boolean logMsg)
msg
- ECMessage - The ECMessage object used for describing the exception.className
- String - The name of the class that threw this ECApplicationException.methodName
- String - The name of the method that threw this ECApplicationException.msgParam
- Oject[] - An array of parameter values to be passed to the message.errorTaskName
- String - The name of the exception handler to handle this message.logMessage
- boolean - indicate that an error message is logged immediatelypublic ECException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.String errorTaskName)
msg
- ECMessage - The ECMessage object used for describing the exception.className
- String - The name of the class that threw this ECApplicationException.methodName
- String - The name of the method that threw this ECApplicationException.errorTaskName
- String - The name of the exception handler to handle this message.public ECException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.String errorTaskName, boolean logMessage)
msg
- ECMessage - TThe ECMessage object used for describing the exception.className
- String - The name of the class that threw this ECApplicationException.methodName
- String - The name of the method that threw this ECApplicationException.errorTaskName
- String - The name of the exception handler to handle this message.logMessage
- boolean - indicate that an error message is logged immediatelypublic ECException(java.lang.String message)
message
- The string used for describing the exception.Method 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 object.public 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
- ECMessage - The ECMessage object used for describing the exception.className
- String - The name of the class that threw this ECException.methodName
- String - The name of the method that threw this ECException.protected void logMessage(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam)
msg
- ECMessage - The ECMessage object used for describing the exception.className
- String - The name of the class that threw this ECException.methodName
- String - The name of the method that threw this ECException.msgParam
- array of object to be passed as parameters to the message.protected void logMessage(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, java.lang.Throwable throwable)
msg
- ECMessage - The ECMessage object used for describing the exception.className
- String - The name of the class that threw this ECException.methodName
- String - The name of the method that threw this ECException.msgParam
- Object[] - array of object to be passed as parameters to the message.throwable
- the throwable object.public void setErrorTaskName(java.lang.String viewtask)
viewtask
- - name of the error view task.public void setException(java.lang.Throwable exc)
exc
- The Throwable object.public void setOrginatingCommand(java.lang.String value)
value
- The name of the command.public void setThrowable(java.lang.Throwable exc)
exc
- The Throwable object.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |