java.lang.Object | +--com.ibm.commerce.beans.InputDataBeanImpl | +--com.ibm.commerce.beans.SmartDataBeanImpl | +--com.ibm.commerce.beans.ErrorDataBean
The bean is for displaying error information on a JSP.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT IBM Copyright notice field. |
Fields inherited from class com.ibm.commerce.beans. SmartDataBeanImpl |
commandContext |
Fields inherited from class com.ibm.commerce.beans. InputDataBeanImpl |
requestProperties |
Fields inherited from interface com.ibm.commerce.beans. DataBean |
emptyString |
Constructor Summary | |
---|---|
ErrorDataBean() Creates a Error DataBean. |
Method Summary | |
---|---|
java.lang.String |
getCorrectiveActionMessage() Return the corrective action error message text. |
java.lang.String |
getCorrectiveActionMessage(java.util.Locale loc) Return the corrective action message in the locale specified. |
ECMessage |
getECCorrectiveActionMessage() Return the corrective ECMessage object associated with the exception. |
ECMessage |
getECMessage() Return the ECMessage object associated with the exception. |
java.lang.String |
getErrorCode() Return the error code if one exists. |
java.lang.Throwable |
getException() Return the actual exception assocated with this error |
TypedProperty |
getExceptionData() Return the user error message data |
java.lang.String |
getExceptionType() Return the exception type |
java.lang.String |
getMessage() Return the user error message text. |
java.lang.String |
getMessage(java.util.Locale loc) Return the user error message text. |
java.lang.String |
getMessageKey() Return the exception message key. |
java.lang.Object[] |
getMessageParam() Return the error message parameters. |
java.lang.String |
getOriginatingCommand() Return the command that originated the exception. |
TypedProperty |
getRequestProperties() Return the inputProperties associated with the Error DataBean. |
java.lang.String |
getStackTrace() Return the exception stack if there is an exception associated with the error |
java.lang.String |
getSystemMessage() Return the system error message text. |
java.lang.String |
getSystemMessage(java.util.Locale loc) Return the system error message text. |
boolean |
hasErrorCode(java.lang.String code) Return true if the exception data contains the input error code, returns false otherwise. |
void |
populate() Populate the error data bean. |
void |
populate(
ECException e) Populate the error data bean. |
void |
setECCorrectiveActionMessage(
ECMessage newValue) Sets the corrective action error message. |
void |
setECMessage(ECMessage newValue) Sets the exception message. |
void |
setExceptionType(java.lang.String newValue) Sets the exception type. |
void |
setOriginatingCommand(java.lang.String newValue) Sets the originating command for the error. |
java.lang.String |
toString() Returns the string representation of the object. |
Methods inherited from class com.ibm.commerce.beans. SmartDataBeanImpl |
fulfills,
getCommandContext,
getResources,
setCommandContext |
Methods inherited from class com.ibm.commerce.beans. InputDataBeanImpl |
setRequestProperties |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait,
wait, wait |
Methods inherited from interface com.ibm.commerce.beans. InputDataBean |
setRequestProperties |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
public ErrorDataBean()
Method Detail |
---|
public java.lang.String getCorrectiveActionMessage()
public java.lang.String getCorrectiveActionMessage(java.util.Locale loc)
loc
- the locale for the message.public ECMessage getECCorrectiveActionMessage()
public ECMessage getECMessage()
public java.lang.String getErrorCode()
public java.lang.Throwable getException()
public TypedProperty getExceptionData()
public java.lang.String getExceptionType()
public java.lang.String getMessage()
public java.lang.String getMessage(java.util.Locale loc)
loc
- the locale for the message text.public java.lang.String getMessageKey()
public java.lang.Object[] getMessageParam()
public java.lang.String getOriginatingCommand()
public TypedProperty getRequestProperties()
getRequestProperties
in interface
InputDataBean
getRequestProperties
in class
InputDataBeanImpl
public java.lang.String getStackTrace()
public java.lang.String getSystemMessage()
public java.lang.String getSystemMessage(java.util.Locale loc)
loc
- the locale for the message text.public boolean hasErrorCode(java.lang.String code)
public void populate()
populate
in interface
SmartDataBean
populate
in class
SmartDataBeanImpl
public void populate(ECException e)
public void setECCorrectiveActionMessage(ECMessage newValue)
public void setECMessage(ECMessage newValue)
public void setExceptionType(java.lang.String newValue)
public void setOriginatingCommand(java.lang.String newValue)
public java.lang.String toString()
toString
in class java.lang.Object