 | Uiinfrastructure API Docs | ||
UIErrorHandler Members | |||
| Uiinfrastructure API Docs | ||
UIErrorHandler Members | |||
  ClearError | Overloaded. Call this method to clear the specified error from the current user's collection of UIError objects. This method should be called when it is no longer appropriate for users to see error messages generated for the passed error. |
| ClearErrors | Call this method to clear all errors from the current user's collection of errors. Note that this will clear all errors having scope ALL_USERS, and all errors having scope ADMIN_USERS, and all errors having scope CURRENT_USER raised under usage of the current users. Errors raised during usage of other users will not be cleared. |
| ClearErrorsForASChange | Call this method to clear those errors that are associated with a specific activity space. UIError objects can be associated with a particular activity space. When the user leaves that activity space, such errors should be cleared from the user's collection of errors. |
| ClearErrorsRequiringASeparateDisplayPage | |
| GetDisplayAdminErrors | Overloaded. Call this method to determine whether or not the current user should see admin-only errors. This implementation of this method will always return false. More specific subclasses of UIErrorHandler will return more meaningful values. For example, PTErrorHandler will determine if the current user is an admin users, and return a value based on this fact. |
| GetErrors | Overloaded. Call this method to obtain an enumeration of the current user's collection of errors. |
| IsErrorPageRequired | Call this method to determine whether or not there are any errors for this user requiring their own error display page. Some errors are displayed on the current portal page, other errors require their own separate display page. |
| RaiseError | Call this method to raise an error for display. The appropriate users will see this error displayed in the appropriate way. Calling this method will log error information. Calling this method will cause the passed UIError object to be saved on the session or application as appropriate. |
| StaticInit | Initializes static admin error helper. Can only be called once globally. |
|
UIErrorHandler Constructor
|
Initializes a new instance of the UIErrorHandler class. |
| Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object. |
| 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. |
| GetType (inherited from Object) | Gets the Type of the current instance. |
| 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. |
UIErrorHandler Class | com.plumtree.uiinfrastructure.errordisplay Namespace