ErrorDataBean

java.lang.Object
- com.ibm.commerce.beans.InputDataBeanImpl
- - com.ibm.commerce.beans.SmartDataBeanImpl
  - - com.ibm.commerce.beans.ErrorDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, java.io.Serializable
```
public class ErrorDataBean
extends SmartDataBeanImpl
```
This class defines a data bean is used for displaying error information on a JSP page.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM Copyright notice field.
- Fields inherited from interface com.ibm.commerce.beans.DataBean
  emptyString

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM Copyright notice field.

Constructor Summary

Constructors
Constructor and Description

ErrorDataBean()
This is the default constructor for this class.

Constructors
Constructor and Description
`ErrorDataBean()` This is the default constructor for this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCorrectiveActionMessage()` This method gets the corrective action error message text.
`java.lang.String`	`getCorrectiveActionMessage(java.util.Locale loc)` This method gets the corrective action message in the locale specified.
`java.lang.String`	`getCorrelationIdentifier()` This method gets the correlation identifier associated with the error.
`ECMessage`	`getECCorrectiveActionMessage()` This method gets the corrective `ECMessage` object associated with the exception.
`ECMessage`	`getECMessage()` This method gets the `ECMessage` object associated with the exception.
`java.lang.String`	`getErrorCode()` This method gets the error code if one exists.
`java.lang.Throwable`	`getException()` This method gets the actual exception associated with this error.
`TypedProperty`	`getExceptionData()` This method gets the user error message data associated with the exception.
`java.lang.String`	`getExceptionType()` This method gets the exception type.
`java.lang.String`	`getMessage()` This method gets the user error message text.
`java.lang.String`	`getMessage(java.util.Locale loc)` This method gets the user error message text.
`java.lang.String`	`getMessageKey()` This method gets the exception message key.
`java.lang.Object[]`	`getMessageParam()` This method gets the error message parameters.
`java.lang.String`	`getOriginatingCommand()` This method gets the command that originated the exception.
`TypedProperty`	`getRequestProperties()` This method gets the input properties associated with the error data bean.
`java.lang.Throwable`	`getRootCause()` This method returns the root cause of an exception
`java.lang.String`	`getStackTrace()` This method gets the exception stack if there is an exception associated with the error.
`java.lang.String`	`getSystemMessage()` This method gets the system error message text.
`java.lang.String`	`getSystemMessage(java.util.Locale loc)` This method gets the system error message text.
`boolean`	`hasErrorCode(java.lang.String code)` This method gets whether the exception data contains the input error code.
`void`	`populate()` This method populates the error data bean.
`void`	`populate(ECException e)` This method populates the error data bean with the given exception.
`void`	`setECCorrectiveActionMessage(ECMessage newValue)` This method sets the corrective action error message.
`void`	`setECMessage(ECMessage newValue)` This method sets the exception message.
`void`	`setException(java.lang.Throwable throwable)` This method sets the exception of the error data bean.
`void`	`setExceptionType(java.lang.String newValue)` This method sets the exception type.
`void`	`setOriginatingCommand(java.lang.String newValue)` This method sets the originating command for the error.
`java.lang.String`	`toString()` This method gets a `String` representation of the object.

Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl
fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext

Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl
setRequestProperties

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.commerce.beans.InputDataBean
setRequestProperties

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM Copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ErrorDataBean
```
public ErrorDataBean()
```
    This is the default constructor for this class.
- Method Detail
  - getCorrectiveActionMessage
```
public java.lang.String getCorrectiveActionMessage()
```
    This method gets the corrective action error message text. The locale of the text is based on the negotiated locale for the user.
    
    Returns:
    
    This method returns the correct action message associated with the error.
  - getCorrectiveActionMessage
```
public java.lang.String getCorrectiveActionMessage(java.util.Locale loc)
```
    This method gets the corrective action message in the locale specified.
    
    Parameters:
    
    loc - This is the locale for the message.
    
    Returns:
    
    This method returns the corrective action message.
  - getECCorrectiveActionMessage
```
public ECMessage getECCorrectiveActionMessage()
```
    This method gets the corrective ECMessage object associated with the exception.
    
    Returns:
    
    This method returns the corrective action message.
  - getECMessage
```
public ECMessage getECMessage()
```
    This method gets the ECMessage object associated with the exception.
    
    Returns:
    
    This method returns the error message.
  - getErrorCode
```
public java.lang.String getErrorCode()
```
    This method gets the error code if one exists.
    
    Returns:
    
    This method returns the error code.
  - getCorrelationIdentifier
```
public java.lang.String getCorrelationIdentifier()
```
    This method gets the correlation identifier associated with the error. This identifier is a unique key that identifies the error on the server. This identifier can be used when correlating system error responses returned to the client.
    
    Returns:
    
    This method returns a unique identifier of the error.
  - getException
```
public java.lang.Throwable getException()
```
    This method gets the actual exception associated with this error.
    
    Returns:
    
    This method returns the underlying exception of the data bean.
  - getExceptionData
```
public TypedProperty getExceptionData()
```
    This method gets the user error message data associated with the exception.
    
    Returns:
    
    This method returns the data associated with the exception.
  - getExceptionType
```
public java.lang.String getExceptionType()
```
    This method gets the exception type.
    
    Returns:
    
    This method returns the exception type.
  - getMessage
```
public java.lang.String getMessage()
```
    This method gets the user error message text. The locale of the text is based on the negotiated locale for the user.
    
    Returns:
    
    This method returns the message of the exception.
  - getMessage
```
public java.lang.String getMessage(java.util.Locale loc)
```
    This method gets the user error message text.
    
    Parameters:
    
    loc - This is the locale for the message text.
    
    Returns:
    
    This method returns the message of the exception in the specified locale.
  - getMessageKey
```
public java.lang.String getMessageKey()
```
    This method gets the exception message key.
    
    Returns:
    
    This method returns the message key of the exception.
  - getMessageParam
```
public java.lang.Object[] getMessageParam()
```
    This method gets the error message parameters.
    
    Returns:
    
    This method returns the message parameters of the exception message.
  - getOriginatingCommand
```
public java.lang.String getOriginatingCommand()
```
    This method gets the command that originated the exception.
    
    Returns:
    
    This method returns the command causing the exception.
  - getRequestProperties
```
public TypedProperty getRequestProperties()
```
    This method gets the input properties associated with the error data bean.
    
    Specified by:
    
    getRequestProperties in interface InputDataBean
    
    Overrides:
    
    getRequestProperties in class InputDataBeanImpl
    
    Returns:
    
    This method returns the request properties.
  - getStackTrace
```
public java.lang.String getStackTrace()
```
    This method gets the exception stack if there is an exception associated with the error.
    
    Returns:
    
    This method returns the stack trace of the exception.
  - getSystemMessage
```
public java.lang.String getSystemMessage()
```
    This method gets the system error message text. The locale of the text is based on the negotiated locale for the user.
    
    Returns:
    
    This method returns the system exception message.
  - getSystemMessage
```
public java.lang.String getSystemMessage(java.util.Locale loc)
```
    This method gets the system error message text.
    
    Parameters:
    
    loc - This is the locale for the message text.
    
    Returns:
    
    This method returns the system exception message in the specified locale.
  - hasErrorCode
```
public boolean hasErrorCode(java.lang.String code)
```
    This method gets whether the exception data contains the input error code.
    
    Returns:
    
    This method returns the true if there is an error code associated with the exception and false otherwise.
  - populate
```
public void populate()
```
    This method populates the error data bean. The bean properties will be populated from the requestProperties object associated with the bean.
    
    Specified by:
    
    populate in interface SmartDataBean
    
    Overrides:
    
    populate in class SmartDataBeanImpl
  - populate
```
public void populate(ECException e)
```
    This method populates the error data bean with the given exception. The bean properties will be populated from the requestProperties object associated with the bean.
    
    Parameters:
    
    e - This is the exception with which the bean will be populated.
  - setECCorrectiveActionMessage
```
public void setECCorrectiveActionMessage(ECMessage newValue)
```
    This method sets the corrective action error message.
  - setECMessage
```
public void setECMessage(ECMessage newValue)
```
    This method sets the exception message.
    
    Parameters:
    
    newValue - This is the exception message.
  - setExceptionType
```
public void setExceptionType(java.lang.String newValue)
```
    This method sets the exception type.
    
    Parameters:
    
    newValue - This is the exception type.
  - setException
```
public void setException(java.lang.Throwable throwable)
```
    This method sets the exception of the error data bean.
    
    Parameters:
    
    throwable - This is the exception of the error data bean.
  - setOriginatingCommand
```
public void setOriginatingCommand(java.lang.String newValue)
```
    This method sets the originating command for the error.
    
    Parameters:
    
    newValue - This is the originating command.
  - toString
```
public java.lang.String toString()
```
    This method gets a String representation of the object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    This method returns a String representation of the object.
  - getRootCause
```
public java.lang.Throwable getRootCause()
```
    This method returns the root cause of an exception
    
    Returns:
    
    The root cause of the exception

Fields inherited from interface com.ibm.commerce.beans.DataBean

Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.beans.InputDataBean

COPYRIGHT

ErrorDataBean

getCorrectiveActionMessage

getCorrectiveActionMessage

getECCorrectiveActionMessage

getECMessage

getErrorCode

getCorrelationIdentifier

getException

getExceptionData

getExceptionType

getMessage

getMessage

getMessageKey

getMessageParam

getOriginatingCommand

getRequestProperties

getStackTrace

getSystemMessage

getSystemMessage

hasErrorCode

populate

populate

setECCorrectiveActionMessage

setECMessage

setExceptionType

setException

setOriginatingCommand

toString

getRootCause