com.ibm.commerce.exception

Class ECApplicationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.ibm.websphere.exception.DistributedException

com.ibm.websphere.command.CommandException

com.ibm.commerce.exception.ECException

com.ibm.commerce.exception.ECApplicationException

All Implemented Interfaces:

com.ibm.commerce.exception.ECCorrelatedIdentity, com.ibm.websphere.exception.DistributedExceptionEnabled, java.io.Serializable

Direct Known Subclasses:

CampaignInitiativeScheduleConflictException, InvalidParameterValueException, NoAddJobException, ParameterNotFoundException, PromotionCodeException, ServiceMappingException

public class ECApplicationException
extends ECException
implements java.io.Serializable

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
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, EXCEP_DATA, EXCEP_TYPE, EXCEPTION, GENERIC_APPLICATION_ERROR_TASK, GENERIC_SYSTEM_ERROR_TASK, MSG_PARAM, SYSTEM_ERROR

Constructor Summary

Constructors

Constructor and Description
ECApplicationException() This is the default constructor for this class.
ECApplicationException(ApplicationError applicationError) This is a constructor for this class which has one parameter.
ECApplicationException(ECMessage ecMessage, java.lang.Object[] msgParam) This is the default constructor for this class.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName) This is a constructor for this class which has three parameters.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, boolean logMessage) This is a constructor for this class which has four parameters.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam) This is a constructor for this class which has four parameters.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, boolean logMessage) This is a constructor for this class which has five parameters.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, java.lang.String errorTaskName) This is a constructor for this class which has five parameters.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, java.lang.String errorTaskName, boolean logMessage) This is a constructor for this class which has six parameters.
ECApplicationException(ECMessage ecMessage, java.lang.String className, java.lang.String methodName, java.lang.Object[] messageParameters, java.lang.String errorTaskName, java.lang.String[] symptomData, ECParameterError[] ecParameterErrors) This is a constructor for this class which has eight parameters.
ECApplicationException(ECMessage ecMessage, java.lang.String className, java.lang.String methodName, java.lang.Object[] messageParameters, java.lang.String errorTaskName, java.lang.String[] symptomData, ECParameterError[] ecParameterErrors, java.lang.Throwable throwable) This is a constructor for this class which has nine parameters.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, java.lang.String errorTaskName, TypedProperty exceptionData) This is a constructor for this class which has six parameters.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, java.lang.String errorTaskName, TypedProperty exceptionData, boolean logMessage) This is a constructor for this class which has seven parameters.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, TypedProperty exceptionData) This is a constructor for this class which has five parameters.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.Object[] msgParam, TypedProperty exceptionData, boolean logMessage) This is a constructor for this class which has six parameters.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.String errorTaskName) This is a constructor for this class which has four parameters.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.String errorTaskName, boolean logMessage) This is a constructor for this class which has five parameters.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.String errorTaskName, TypedProperty exceptionData) This is a constructor for this class which has five parameters.
ECApplicationException(ECMessage msg, java.lang.String className, java.lang.String methodName, java.lang.String errorTaskName, TypedProperty exceptionData, boolean logMessage) This is a constructor for this class which has six parameters.
ECApplicationException(java.lang.Throwable throwable) This is a constructor for this class which has one parameter.

Method Summary

Modifier and Type	Method and Description
ECParameterError[]	getECParameterErrors() This method returns the ECParameterError objects associated with the exception.
java.lang.String	getErrorType() This method gets the type of error.
TypedProperty	getExceptionFields() This method gets the parameters that caused the exception.
java.lang.String	getGenericErrorTask() This method gets the generic error task.
java.lang.String	getMessage() This method returns the localized message of the exception.
void	setExceptionField(java.lang.String key, java.lang.Object value) This method sets a name/value pair in the exception fields object.
void	setExceptionFields(TypedProperty userParam) This method sets the parameters that caused the exception.

Methods inherited from class com.ibm.commerce.exception.ECException

addLogData, addLogData, getCorrelationIdentifier, getECMessage, getErrorMessageKey, getErrorProperties, getErrorTaskName, getMessageKey, getMessageParameters, getStackTrace, getSymptomData, getThrowable, getUserMessage, isRecoverable, printStackTrace, printStackTrace, setErrorTaskName, setException, setOrginatingCommand, setRecoverable, setThrowable

Methods inherited from class com.ibm.websphere.command.CommandException

getException

Methods inherited from class com.ibm.websphere.exception.DistributedException

getException, getExceptionInfo, getOriginalException, getPreviousException, printStackTrace, printSuperStackTrace, printSuperStackTrace, setDefaultMessage, setLocalizationInfo

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, 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()

This is the default constructor for this class.

ECApplicationException

public ECApplicationException(ECMessage ecMessage,
                              java.lang.Object[] msgParam)

This is the default constructor for this class.

Parameters:

ecMessage - The ECMessage object.

msgParam - An Object array of parameter values to be passed to the message.

ECApplicationException

public ECApplicationException(ApplicationError applicationError)

This is a constructor for this class which has one parameter.

Parameters:

applicationError - The ApplicationError object from AbstractBusinessObjectDocumentException.

ECApplicationException

public ECApplicationException(java.lang.Throwable throwable)

This is a constructor for this class which has one parameter.

Parameters:

throwable - The root of the exception.

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName)

This is a constructor for this class which has three parameters.

Parameters:

msg - An 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)

This is a constructor for this class which has four parameters.

Parameters:

msg - An 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 Object 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)

This is a constructor for this class which has five parameters.

Parameters:

msg - An 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 Object array of parameter values to be passed to the message.

exceptionData - A TypedProperty object representing the 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)

This is a constructor for this class which has six parameters.

Parameters:

msg - An 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 Object array of parameter values to be passed to the message.

exceptionData - A TypedProperty object representing the name/value pairs of the error fields and their corresponding values.

logMessage - A boolean value indicating whether an error message is logged immediately (true if it is, false otherwise)

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.Object[] msgParam,
                              java.lang.String errorTaskName)

This is a constructor for this class which has five parameters.

Parameters:

msg - An 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 Object 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)

This is a constructor for this class which has six parameters.

Parameters:

msg - An 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 Object array of parameter values to be passed to the message.

errorTaskName - The name of the exception handler to handle this message.

exceptionData - A TypedProperty object representing the 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)

This is a constructor for this class which has seven parameters.

Parameters:

msg - An 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 Object array of parameter values to be passed to the message.

errorTaskName - The name of the exception handler to handle this message.

exceptionData - A TypedProperty object representing the name/value pairs of the error fields and their corresponding values.

logMessage - A boolean value indicating whether an error message is logged immediately (true if it is, false otherwise).

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.Object[] msgParam,
                              java.lang.String errorTaskName,
                              boolean logMessage)

This is a constructor for this class which has six parameters.

Parameters:

msg - An 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 Object array of parameter values to be passed to the message.

errorTaskName - The name of the exception handler to handle this message.

logMessage - A boolean value indicating whether an error message is logged immediately (true if it is, false otherwise).

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.Object[] msgParam,
                              boolean logMessage)

This is a constructor for this class which has five parameters.

Parameters:

msg - An 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 Object array of parameter values to be passed to the message.

logMessage - A boolean value indicating whether an error message is logged immediately (true if it is, false otherwise).

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.String errorTaskName)

This is a constructor for this class which has four parameters.

Parameters:

msg - An 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)

This is a constructor for this class which has five parameters.

Parameters:

msg - An 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 - A TypedProperty object representing the 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.String errorTaskName,
                              TypedProperty exceptionData,
                              boolean logMessage)

This is a constructor for this class which has six parameters.

Parameters:

msg - An 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 - A TypedProperty object representing the name/value pairs of the error fields and their corresponding values.

logMessage - A boolean value indicating whether an error message is logged immediately (true if it is, false otherwise).

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.String errorTaskName,
                              boolean logMessage)

This is a constructor for this class which has five parameters.

Parameters:

msg - An 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 - A boolean value indicating whether an error message is logged immediately (true if it is, false otherwise).

ECApplicationException

public ECApplicationException(ECMessage msg,
                              java.lang.String className,
                              java.lang.String methodName,
                              boolean logMessage)

This is a constructor for this class which has four parameters.

Parameters:

msg - An 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 - A boolean value indicating whether an error message is logged immediately (true if it is, false otherwise).

ECApplicationException

public ECApplicationException(ECMessage ecMessage,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.Object[] messageParameters,
                              java.lang.String errorTaskName,
                              java.lang.String[] symptomData,
                              ECParameterError[] ecParameterErrors)

This is a constructor for this class which has eight parameters. It creates an application exception.

Parameters:

ecMessage - The message of the exception.

className - The class that throws the exception.

methodName - The method that throws the exception.

messageParameters - The message parameters of the exception.

errorTaskName - The task name of the exception handler to handle this exception.

symptomData - The symptom data associated with the exception.

ecParameterErrors - Any additional errors associated with the exception.

ECApplicationException

public ECApplicationException(ECMessage ecMessage,
                              java.lang.String className,
                              java.lang.String methodName,
                              java.lang.Object[] messageParameters,
                              java.lang.String errorTaskName,
                              java.lang.String[] symptomData,
                              ECParameterError[] ecParameterErrors,
                              java.lang.Throwable throwable)

This is a constructor for this class which has nine parameters. It creates an application exception.

Parameters:

ecMessage - The message of the exception.

className - The class that throws the exception.

methodName - The method that throws the exception.

messageParameters - The message parameters of the exception.

errorTaskName - The task name of the exception handler to handle this exception.

symptomData - The symptom data associated with the exception.

ecParameterErrors - Any additional errors associated with the exception.

throwable - The cause of the exception.

Method Detail

getErrorType

public java.lang.String getErrorType()

This method gets the type of error.

Specified by:

getErrorType in class ECException

Returns:

The error type.

getExceptionFields

public TypedProperty getExceptionFields()

This method gets the parameters that caused the exception.

Returns:

A TypedProperty object containing the name/value pairs of the error fields and their corresponding values.

getGenericErrorTask

public java.lang.String getGenericErrorTask()

This method gets the generic error task.

Specified by:

getGenericErrorTask in class ECException

Returns:

The generic error task.

getMessage

public java.lang.String getMessage()

This method returns the localized message of the exception.

Specified by:

getMessage in interface com.ibm.websphere.exception.DistributedExceptionEnabled

Overrides:

getMessage in class ECException

Returns:

The message associated with the exception.

See Also:

Throwable.getMessage()

setExceptionField

public void setExceptionField(java.lang.String key,
                              java.lang.Object value)

This method 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)

This method sets the parameters that caused the exception.

Parameters:

userParam - The exception parameters.

getECParameterErrors

public ECParameterError[] getECParameterErrors()

This method returns the ECParameterError objects associated with the exception.

Overrides:

getECParameterErrors in class ECException

Returns:

An array of ECParameterError objects associated with the exception.