 | Uiinfrastructure API Docs | ||
UIError Methods | |||
| Uiinfrastructure API Docs | ||
UIError Methods | |||
The methods of the UIError class are listed below. For a complete list of UIError class members, see the UIError Members topic.
 Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object. |
| GetActivitySpace | Call this method to determine the activity space with which this error is associated. This method returns null if this error is not associated with an activity space. |
| GetClearWithActivitySpaceChange | Call this method to determine whether or not this error should be cleared when the user changes activity spaces. |
| GetDisplayOnSeparatePage | Call this method to determine whether or not the error message for this UIError object should be displayed on a separate ui page. |
| GetException | Call this method to obtain the Exception associated with this error. |
| GetExtendedMessage | Call this method to obtain the extended message of this error. |
| GetHashCode (inherited from Object) | Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. |
| GetHTMLMessage | Call this method to obtain the HTMLElement message displayed with this error. |
| GetImmediateClear | |
| GetLevel | |
| GetManualClear | TODOCR JF 12/10/02 - Javadoc? |
| GetMessage | Call this method to obtain the String message displayed along with this error. |
| GetScope | |
| GetSessionKey | Call this method to obtain the key with which this error was stored on the user's session or application. |
| GetTitle | Call this method to obtain the title of this error. |
| GetType (inherited from Object) | Gets the Type of the current instance. |
| SetActivitySpace | Call this method to associate this error with an activity space. This error will only be seen by the user when the user is on the specified activity space. Note that it does not make sense to associate this error with an activity space if this error gets its own display page, because the error display page is its own activity space. |
| SetClearWithActivitySpaceChange | Call this method to toggle whether or not this error should be cleared from memory when the user changes activity spaces. This clearing will only take affect if you also call the SetActivitySpace( String ) method to tie this error to an activity space. |
| SetDisplayOnSeparatePage | Call this method to toggle whether or not the error message for this UIError object should be displayed on a separate ui page. Pass false to have this error displayed on the main portal or editor page. Pass true to have this error displayed on a separate page. |
| SetException | Call this method to set the Exception included within this error. Information from this exception will be logged, but it will not be displayed to the user. |
| SetHTMLMessage | Call this method to set the message displayed along with this error. An error can contain both a String message and an HTMLElement message, and both will be displayed along with the error. |
| SetImmediateClear | |
| SetManualClear | TODOCR JF 12/10/02 - What is this doing? No Javadoc? |
| SetSessionKey | Call this method to set the session key that was used to store this error on the user's session or application. |
| SetTitle | Call this method to set the title of this error. This title will be displayed above the error description. |
| ToString (inherited from Object) | Returns a String that represents the current Object. |
 Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. |
| MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object. |
UIError Class | com.plumtree.uiinfrastructure.errordisplay Namespace