|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
com.retek.commons.gui.util.UiBusinessException
This class is a GUI representation of a BusinessException. It contains a complete list of the business problems within the exception along with a widget name associated to each problem. The default error severity of a UiBusinessException is ERROR.
Retek Inc. Copyright (c) 2002
Field Summary | |
---|---|
static int |
BUSINESS_EXCEPTION_TYPE
|
static int |
UI_EXCEPTION_TYPE
|
Constructor Summary | |
---|---|
UiBusinessException(BusinessException exception)
Constructs a new UiBusinessException based around a Business Exception. |
|
UiBusinessException(java.lang.Exception exception)
Constructs a new UiBusinessException based around a Regular Exception. |
|
UiBusinessException(java.lang.String message)
Constructs a new UiBusinessException based around a message. |
|
UiBusinessException(java.lang.String message,
ErrorSeverity errorSeverity)
Constructs a new UiBusinessException based around a message. |
|
UiBusinessException(java.lang.String widgetName,
java.lang.String message)
Constructs a new UiBusinessException based around a message. |
|
UiBusinessException(java.lang.String widgetName,
java.lang.String message,
ErrorSeverity errorSeverity)
Constructs a new UiBusinessException based around a message. |
Method Summary | |
---|---|
void |
addMessage(java.lang.String widgetName,
java.lang.String message)
Adds a new error message to the exception and associates it with a particular widget. |
java.lang.String |
getLocalizedMessage()
Retrieves the localized primary message of the UiBusiness Exception. |
java.lang.String |
getMessage()
Retrieves the primary message of the UiBusiness Exception. |
java.util.Map |
getMessages()
Retrieves a map of all widget names and messages to display for them. |
ErrorSeverity |
getSeverity()
Retrieves the error severity of the exception (INFO, WARNING, ERROR, FATAL). |
java.lang.Exception |
getStoredException()
Retrieves the underlying exception. |
java.lang.String |
getWidgetName()
Retrieves the very first widget name of the widgets that have errors associated with them. |
boolean |
isBusinessException()
Retrieves whether or not the exception represents a business exception. |
void |
removeMessage(java.lang.String widgetName)
Removes an error message from the exception based on widget name. |
Methods inherited from class java.lang.Throwable |
---|
fillInStackTrace, getCause, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int UI_EXCEPTION_TYPE
public static final int BUSINESS_EXCEPTION_TYPE
Constructor Detail |
public UiBusinessException(java.lang.Exception exception)
public UiBusinessException(BusinessException exception)
public UiBusinessException(java.lang.String message)
message
- The message of the business exception.public UiBusinessException(java.lang.String message, ErrorSeverity errorSeverity)
message
- The message of the business exception.errorSeverity
- The error severity to assign to the exception.public UiBusinessException(java.lang.String widgetName, java.lang.String message)
widgetName
- The widget name of a widget to associate with the message.message
- The message of the business exception.public UiBusinessException(java.lang.String widgetName, java.lang.String message, ErrorSeverity errorSeverity)
widgetName
- The widget name of a widget to associate with the message.message
- The message of the business exception.errorSeverity
- The error severity to assign to the exception.Method Detail |
public void addMessage(java.lang.String widgetName, java.lang.String message)
widgetName
- The widget name of a widget to associate with the message.message
- A message to display for the particular widget (when it has focus).public void removeMessage(java.lang.String widgetName)
widgetName
- The name of the widget/error to remove from the exception.public java.util.Map getMessages()
public java.lang.String getMessage()
public java.lang.String getLocalizedMessage()
public java.lang.String getWidgetName()
public ErrorSeverity getSeverity()
public boolean isBusinessException()
public java.lang.Exception getStoredException()
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |