|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.errordisplay.UIError
public class UIError
Constructor Summary | |
---|---|
UIError(UIErrorLevel level,
UIErrorScope scope,
java.lang.Exception exception,
java.lang.String message,
java.lang.String extendedMessage)
Creates a new UIError object. |
|
UIError(UIErrorLevel level,
UIErrorScope scope,
java.lang.String message,
java.lang.String extendedMessage)
Creates a new UIError object. |
Method Summary | |
---|---|
java.lang.String |
GetActivitySpace()
Call this method to determine the activity space with which this error is associated. |
boolean |
GetClearWithActivitySpaceChange()
Call this method to determine whether or not this error should be cleared when the user changes activity spaces. |
boolean |
GetDisplayOnSeparatePage()
Call this method to determine whether or not the error message for this UIError object should be displayed on a separate ui page. |
java.lang.Exception |
GetException()
Call this method to obtain the Exception associated with this error. |
java.lang.String |
GetExtendedMessage()
Call this method to obtain the extended message of this error. |
HTMLElement |
GetHTMLMessage()
Call this method to obtain the HTMLElement message displayed with this error. |
boolean |
GetImmediateClear()
|
UIErrorLevel |
GetLevel()
|
boolean |
GetManualClear()
TODOCR JF 12/10/02 - Javadoc? |
java.lang.String |
GetMessage()
Call this method to obtain the String message displayed along with this error. |
UIErrorScope |
GetScope()
|
java.lang.String |
GetSessionKey()
Call this method to obtain the key with which this error was stored on the user's session or application. |
java.lang.String |
GetTitle()
Call this method to obtain the title of this error. |
void |
SetActivitySpace(java.lang.String sName)
Call this method to associate this error with an activity space. |
void |
SetClearWithActivitySpaceChange(boolean b)
Call this method to toggle whether or not this error should be cleared from memory when the user changes activity spaces. |
void |
SetDisplayOnSeparatePage(boolean b)
Call this method to toggle whether or not the error message for this UIError object should be displayed on a separate ui page. |
void |
SetException(java.lang.Exception ex)
Call this method to set the Exception included within this error. |
void |
SetHTMLMessage(HTMLElement e)
Call this method to set the message displayed along with this error. |
void |
SetImmediateClear(boolean b)
|
void |
SetManualClear(boolean b)
TODOCR JF 12/10/02 - What is this doing? No Javadoc? |
void |
SetSessionKey(java.lang.String s)
Call this method to set the session key that was used to store this error on the user's session or application. |
void |
SetTitle(java.lang.String title)
Call this method to set the title of this error. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public UIError(UIErrorLevel level, UIErrorScope scope, java.lang.Exception exception, java.lang.String message, java.lang.String extendedMessage)
level
- UIErrorLevel enumeration indicates the severity of this error.scope
- UIErrorScope enumeration indicates the intended audience of this error.exception
- Previously caught exception might provide valuable clues to debuggers.message
- This message will be displayed to the user.extendedMessage
- This message will be embedded in HTML comments.public UIError(UIErrorLevel level, UIErrorScope scope, java.lang.String message, java.lang.String extendedMessage)
level
- UIErrorLevel enumeration indicates the severity of this error.scope
- UIErrorScope enumeration indicates the intended audience of this error.message
- This message will be displayed to the user.extendedMessage
- This message will be embedded in HTML comments.Method Detail |
---|
public java.lang.String GetActivitySpace()
public boolean GetClearWithActivitySpaceChange()
public boolean GetDisplayOnSeparatePage()
public java.lang.Exception GetException()
public java.lang.String GetExtendedMessage()
public HTMLElement GetHTMLMessage()
public boolean GetImmediateClear()
public UIErrorLevel GetLevel()
public boolean GetManualClear()
public java.lang.String GetMessage()
public UIErrorScope GetScope()
public java.lang.String GetSessionKey()
public java.lang.String GetTitle()
public void SetActivitySpace(java.lang.String sName)
sName
- Pass the String name of the activity space.public void SetClearWithActivitySpaceChange(boolean b)
b
- boolean valuepublic void SetDisplayOnSeparatePage(boolean b)
b
- boolean value.public void SetException(java.lang.Exception ex)
ex
- Exceptionpublic void SetHTMLMessage(HTMLElement e)
e
- HTMLElement message.public void SetImmediateClear(boolean b)
b
- public void SetManualClear(boolean b)
b
- public void SetTitle(java.lang.String title)
title
- String titlepublic void SetSessionKey(java.lang.String s)
s
- String key.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |