com.ibm.commerce.exception
Class ECApplicationException

com.ibm.commerce.exception.ECException
  |
  +--com.ibm.commerce.exception.ECApplicationException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
InvalidParameterValueException, NoAddJobException, ParameterNotFoundException, PersonalizationRuleServerNotAvailableException, PersonalizationRuleServiceExistsException, PersonalizationRuleServiceNotEnabledException, PersonalizationRuleServiceNotFoundException, RuleServerNotFoundException

public class ECApplicationException
extends ECException

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
           
static java.lang.String GENERIC_ERROR_TASK
           
 
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()
          Constructs an ECApplicationException with an ECMessage object.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName)
          Constructs an 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)
          Constructs an ECApplicationException with an ECMessage object.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, boolean logMessage)
          Constructs an ECApplicationException with an ECMessage object.
ECApplicationException(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.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, java.lang.String errorTaskName, boolean logMessage)
          Constructs an 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)
          Constructs an 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)
          Constructs an ECApplicationException with an ECMessage object.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, TypedProperty exceptionData)
          Constructs an ECApplicationException with an ECMessage object.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, TypedProperty exceptionData, boolean logMessage)
          Constructs an ECApplicationException with an ECMessage object.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.String errorTaskName)
          Constructs an ECApplicationException with an ECMessage object.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.String errorTaskName, boolean logMessage)
          Constructs an ECApplicationException with an ECMessage object.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.String errorTaskName, TypedProperty exceptionData)
          Constructs an ECApplicationException with an ECMessage object.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.String errorTaskName, TypedProperty exceptionData, boolean logMessage)
          Constructs an 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
 

Field Detail

ERROR_TYPE

public static final java.lang.String ERROR_TYPE

GENERIC_ERROR_TASK

public static final java.lang.String GENERIC_ERROR_TASK
Constructor Detail

ECApplicationException

public ECApplicationException()
Constructs an ECApplicationException with an ECMessage object.

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName)
Constructs an ECApplicationException with an ECMessage object.
Parameters:
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.

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              boolean logMessage)
Constructs an ECApplicationException with an ECMessage object.
Parameters:
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.
logMessage - boolean - indicate that an error message is logged immediately

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.Object[] msgParam)
Constructs an ECApplicationException with an ECMessage object.
Parameters:
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.

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.Object[] msgParam,
                              boolean logMessage)
Constructs an ECApplicationException with an ECMessage object.
Parameters:
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.
logMessage - boolean - indicate that 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)
Constructs an ECApplicationException with an ECMessage object.
Parameters:
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.

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.Object[] msgParam,
                              java.lang.String errorTaskName,
                              boolean logMessage)
Constructs an ECApplicationException with an ECMessage object.
Parameters:
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.
logMessage - boolean - indicate that 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,
                              TypedProperty exceptionData)
Constructs an ECApplicationException with an ECMessage object.
Parameters:
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.

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)
Constructs an ECApplicationException with an ECMessage object.
Parameters:
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.
exceptionData - TypedProperty - additional data associated with exception
logMessage - boolean - indicate that an error message is logged immediately

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.Object[] msgParam,
                              TypedProperty exceptionData)
Constructs an ECApplicationException with an ECMessage object.
Parameters:
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.
exceptionData - TypedProperty- 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)
Constructs an ECApplicationException with an ECMessage object.
Parameters:
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.
exceptionData - TypedProperty- A Hashtable of name value pairs of the error fields and their corresponding values.
logMessage - boolean - indicate that an error message is logged immediately

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.String errorTaskName)
Constructs an ECApplicationException with an ECMessage object.
Parameters:
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.

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.String errorTaskName,
                              boolean logMessage)
Constructs an ECApplicationException with an ECMessage object.
Parameters:
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.
logMessage - boolean - indicate that an error message is logged immediately

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.String errorTaskName,
                              TypedProperty exceptionData)
Constructs an ECApplicationException with an ECMessage object.
Parameters:
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.
exceptionData - TypedProperty - 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)
Constructs an ECApplicationException with an ECMessage object.
Parameters:
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.
exceptionData - TypedProperty - additional data associated with exception
logMessage - boolean - indicate that an error message is logged immediately
Method Detail

getErrorType

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

getExceptionFields

public TypedProperty getExceptionFields()
Gets the parameters that caused the exception.
Returns:
(java.util.Hashtable) 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
Overrides:
getGenericErrorTask in class ECException
Returns:
(java.lang.String) 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 - String - the name of an exception data
value - Object - the value of the exception data.

setExceptionFields

public void setExceptionFields(TypedProperty userParam)
Sets the parameters that caused the exception.
Parameters:
exceptionFields - TypedProperty - A Hashtable of name value pairs of the error fields and their corresponding values.