com.ibm.commerce.exception
Class ECApplicationException

java.lang.Object
  |
  +--CommandException
        |
        +--com.ibm.commerce.exception.ECException
              |
              +--com.ibm.commerce.exception.ECApplicationException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
CampaignInitiativeScheduleConflictException, InvalidParameterValueException, NoAddJobException, ParameterNotFoundException

public class ECApplicationException
extends ECException
implements java.io.Serializable

ECApplicationException is the class of exceptions thrown by the WebSphere Commerce Application Server when application errors occur during the processing of business logic.

See Also:
Serialized Form

Field Summary
static java.lang.String ERROR_TYPE
          Default value of the error type parameter
static java.lang.String GENERIC_ERROR_TASK
          Default value of the generic error task parameter
 
Fields inherited from class com.ibm.commerce.exception. ECException
APPLICATION_ERROR, ECMESSAGE, ECMESSAGEKEY, errorProperties, EXCEP_DATA, EXCEP_TYPE, EXCEPTION, GENERIC_APPLICATION_ERROR_TASK, GENERIC_SYSTEM_ERROR_TASK, MSG_PARAM, SYSTEM_ERROR
 
Constructor Summary
ECApplicationException()
          Constructor for ECApplicationException.
ECApplicationException( ECMessage msg, java.lang.String className, java.lang.String methodName)
          Constructor for ECApplicationException with an ECMessage object.
ECApplicationException( ECMessage msg, java.lang.String className, java.lang.String methodName, boolean logMessage)
          Constructs an ECApplicationException with an ECMessage object.
ECApplicationException( ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam)
          Constructor for ECApplicationException with an ECMessage object.
ECApplicationException( ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, boolean logMessage)
          Constructor for ECApplicationException with an ECMessage object.
ECApplicationException( 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.
ECApplicationException( ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, java.lang.String errorTaskName, boolean logMessage)
          Constructor for ECApplicationException with an ECMessage object.
ECApplicationException( ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, java.lang.String errorTaskName, TypedProperty exceptionData)
          Constructor for ECApplicationException with an ECMessage object.
ECApplicationException( ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, java.lang.String errorTaskName, TypedProperty exceptionData, boolean logMessage)
          Constructor for ECApplicationException with an ECMessage object.
ECApplicationException( ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, TypedProperty exceptionData)
          Constructor for ECApplicationException with an ECMessage object.
ECApplicationException( ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, TypedProperty exceptionData, boolean logMessage)
          Constructor for ECApplicationException with an ECMessage object.
ECApplicationException( ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.String errorTaskName)
          Constructor for ECApplicationException with an ECMessage object.
ECApplicationException( ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.String errorTaskName, boolean logMessage)
          Constructor for ECApplicationException with an ECMessage object.
ECApplicationException( ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.String errorTaskName, TypedProperty exceptionData)
          Constructor for ECApplicationException with an ECMessage object.
ECApplicationException( ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.String errorTaskName, TypedProperty exceptionData, boolean logMessage)
          Constructor for ECApplicationException with an ECMessage object.
 
Method Summary
 java.lang.String getErrorType()
          Gets the type of error.
  TypedProperty getExceptionFields()
          Gets the parameters that caused the exception.
 java.lang.String getGenericErrorTask()
          Gets the generic error task
 void setExceptionField(java.lang.String key, java.lang.Object value)
          Sets a name value pair in the exception fields object.
 void setExceptionFields( TypedProperty userParam)
          Sets the parameters that caused the exception.
 
Methods inherited from class com.ibm.commerce.exception. ECException
getErrorMessageKey, getErrorProperties, getErrorTaskName, getMessageKey, getStackTrace, getThrowable, getUserMessage, logMessage, logMessage, logMessage, setErrorTaskName, setException, setOrginatingCommand, setThrowable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

GENERIC_ERROR_TASK

public static final java.lang.String GENERIC_ERROR_TASK
Default value of the generic error task parameter
See Also:
Constant Field Values

ERROR_TYPE

public static final java.lang.String ERROR_TYPE
Default value of the error type parameter
See Also:
Constant Field Values
Constructor Detail

ECApplicationException

public ECApplicationException()
Constructor for ECApplicationException.

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName)
Constructor for ECApplicationException with an ECMessage object.
Parameters:
msg - the ECMessage object used for describing the exception.
className - the name of the class that threw this ECApplicationException.
methodName - the name of the method that threw this ECApplicationException.

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.Object[] msgParam)
Constructor for ECApplicationException with an ECMessage object.
Parameters:
msg - the ECMessage object used for describing the exception.
className - tThe name of the class that threw this ECApplicationException.
methodName - the name of the method that threw this ECApplicationException.
msgParam - an array of parameter values to be passed to the message.

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.Object[] msgParam,
TypedProperty exceptionData)
Constructor for ECApplicationException with an ECMessage object.
Parameters:
msg - the ECMessage object used for describing the exception.
className - the name of the class that threw this ECApplicationException.
methodName - the name of the method that threw this ECApplicationException.
msgParam - an array of parameter values to be passed to the message.
exceptionData - a Hashtable of name value pairs of the error fields and their corresponding values.

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.Object[] msgParam,
TypedProperty exceptionData,
                              boolean logMessage)
Constructor for ECApplicationException with an ECMessage object.
Parameters:
msg - the ECMessage object used for describing the exception.
className - the name of the class that threw this ECApplicationException.
methodName - the name of the method that threw this ECApplicationException.
msgParam - an array of parameter values to be passed to the message.
exceptionData - a Hashtable of name value pairs of the error fields and their corresponding values.
logMessage - true if an error message is logged immediately

ECApplicationException

public ECApplicationException(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.
Parameters:
msg - the ECMessage object used for describing the exception.
className - the name of the class that threw this ECApplicationException.
methodName - the name of the method that threw this ECApplicationException.
msgParam - an array of parameter values to be passed to the message.
errorTaskName - the name of the exception handler to handle this message.

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.Object[] msgParam,
                              java.lang.String errorTaskName,
TypedProperty exceptionData)
Constructor for ECApplicationException with an ECMessage object.
Parameters:
msg - the ECMessage object used for describing the exception.
className - the name of the class that threw this ECApplicationException.
methodName - the name of the method that threw this ECApplicationException.
msgParam - an array of parameter values to be passed to the message.
errorTaskName - the name of the exception handler to handle this message.
exceptionData - a Hashtable of name value pairs of the error fields and their corresponding values.

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.Object[] msgParam,
                              java.lang.String errorTaskName,
TypedProperty exceptionData,
                              boolean logMessage)
Constructor for ECApplicationException with an ECMessage object.
Parameters:
msg - the ECMessage object used for describing the exception.
className - the name of the class that threw this ECApplicationException.
methodName - the name of the method that threw this ECApplicationException.
msgParam - an array of parameter values to be passed to the message.
errorTaskName - the name of the exception handler to handle this message.
exceptionData - additional data associated with exception
logMessage - true if an error message is logged immediately

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.Object[] msgParam,
                              java.lang.String errorTaskName,
                              boolean logMessage)
Constructor for ECApplicationException with an ECMessage object.
Parameters:
msg - the ECMessage object used for describing the exception.
className - the name of the class that threw this ECApplicationException.
methodName - the name of the method that threw this ECApplicationException.
msgParam - an array of parameter values to be passed to the message.
errorTaskName - the name of the exception handler to handle this message.
logMessage - true if an error message is logged immediately

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.Object[] msgParam,
                              boolean logMessage)
Constructor for ECApplicationException with an ECMessage object.
Parameters:
msg - the ECMessage object used for describing the exception.
className - the name of the class that threw this ECApplicationException.
methodName - the name of the method that threw this ECApplicationException.
msgParam - an array of parameter values to be passed to the message.
logMessage - true if an error message is logged immediately

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.String errorTaskName)
Constructor for ECApplicationException with an ECMessage object.
Parameters:
msg - the ECMessage object used for describing the exception.
className - the name of the class that threw this ECApplicationException.
methodName - the name of the method that threw this ECApplicationException.
errorTaskName - the name of the exception handler to handle this message.

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.String errorTaskName,
TypedProperty exceptionData)
Constructor for ECApplicationException with an ECMessage object.
Parameters:
msg - the ECMessage object used for describing the exception.
className - the name of the class that threw this ECApplicationException.
methodName - the name of the method that threw this ECApplicationException.
errorTaskName - the name of the exception handler to handle this message.
exceptionData - additional data associated with exception

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.String errorTaskName,
TypedProperty exceptionData,
                              boolean logMessage)
Constructor for ECApplicationException with an ECMessage object.
Parameters:
msg - the ECMessage object used for describing the exception.
className - the name of the class that threw this ECApplicationException.
methodName - the name of the method that threw this ECApplicationException.
errorTaskName - the name of the exception handler to handle this message.
exceptionData - additional data associated with exception
logMessage - true if an error message is logged immediately

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.String errorTaskName,
                              boolean logMessage)
Constructor for ECApplicationException with an ECMessage object.
Parameters:
msg - tThe ECMessage object used for describing the exception.
className - the name of the class that threw this ECApplicationException.
methodName - the name of the method that threw this ECApplicationException.
errorTaskName - the name of the exception handler to handle this message.
logMessage - true if an error message is logged immediately

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              boolean logMessage)
Constructs an ECApplicationException with an ECMessage object.
Parameters:
msg - the ECMessage object used for describing the exception.
className - the name of the class that threw this ECApplicationException.
methodName - the name of the method that threw this ECApplicationException.
logMessage - true if an error message is logged immediately
Method Detail

getErrorType

public java.lang.String getErrorType()
Gets the type of error.
Specified by:
getErrorType in class ECException
Returns:
the error type.

getExceptionFields

public TypedProperty getExceptionFields()
Gets the parameters that caused the exception.
Returns:
a Hashtable of name value pairs of the error fields and their corresponding values

getGenericErrorTask

public java.lang.String getGenericErrorTask()
Gets the generic error task
Specified by:
getGenericErrorTask in class ECException
Returns:
the generic error task.

setExceptionField

public void setExceptionField(java.lang.String key,
                              java.lang.Object value)
Sets a name value pair in the exception fields object.
Parameters:
key - the name of an exception data
value - the value of the exception data.

setExceptionFields

public void setExceptionFields(TypedProperty userParam)
Sets the parameters that caused the exception.
Parameters:
userParam - the exception parameters