|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.errordisplay.UIErrorHandler
public class UIErrorHandler
Constructor Summary | |
---|---|
UIErrorHandler()
|
Method Summary | |
---|---|
static void |
ClearError(java.lang.String sKey,
ISessionManager sessionManager,
IApplication application)
Call this method to clear the specified error from the current user's collection of UIError objects. |
static void |
ClearError(UIError error,
ISessionManager sessionManager,
IApplication application)
Call this method to clear the specified error from the current user's collection of UIError objects. |
static void |
ClearErrors(ISessionManager sessionManager,
IApplication application)
Call this method to clear all errors from the current user's collection of errors. |
static void |
ClearErrorsForASChange(java.lang.String sNewASName,
ISessionManager sessionManager,
IApplication application)
Call this method to clear those errors that are associated with a specific activity space. |
static void |
ClearErrorsRequiringASeparateDisplayPage(ISessionManager sessionManager,
IApplication application,
AActivitySpace space,
boolean bForThisAs,
boolean bIncludeAdminErrors)
|
static boolean |
GetDisplayAdminErrors(AActivitySpace space)
Call this method to determine whether or not the current user should see admin-only errors. |
static boolean |
GetDisplayAdminErrors(java.lang.Object session)
Call this method to obtain a boolean value indicating whether or not the current user should see errors intended for administrators. |
static IXPEnumerator |
GetErrors(ISessionManager sessionManager,
IApplication application)
Deprecated. |
static IXPEnumerator |
GetErrors(ISessionManager sessionManager,
IApplication application,
AActivitySpace space,
boolean bForThisAs,
boolean bIncludeAdminErrors)
Call this method to obtain an enumeration of the current user's collection of errors that are associated with a given activity space. |
static boolean |
IsErrorPageRequired(ISessionManager sessionManager,
IApplication application,
boolean bIncludeAdminErrors)
Call this method to determine whether or not there are any errors for this user requiring their own error display page. |
static void |
RaiseError(UIError error,
ISessionManager sessionManager,
IApplication application)
Call this method to raise an error for display. |
static void |
StaticInit(IAdminUIErrorHelper _adminUIErrorHelper)
Initializes static admin error helper. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public UIErrorHandler()
Method Detail |
---|
public static void StaticInit(IAdminUIErrorHelper _adminUIErrorHelper)
IAdminUIErrorHelper
- a helper classpublic static void ClearError(UIError error, ISessionManager sessionManager, IApplication application)
error
- Pass the UIError object you wish cleared from the current
user's collection of errors.sessionManager
- Pass the current user's ISessionManagerapplication
- Pass the IApplicationpublic static void ClearError(java.lang.String sKey, ISessionManager sessionManager, IApplication application)
sKey
- Pass the key used to store the error you wish to clear.sessionManager
- Pass the current user's ISessionManagerapplication
- Pass the IApplicationpublic static void ClearErrors(ISessionManager sessionManager, IApplication application)
sessionManager
- Pass the current user's ISessionManagerapplication
- Pass the IApplicationpublic static void ClearErrorsForASChange(java.lang.String sNewASName, ISessionManager sessionManager, IApplication application)
sNewASName
- Pass the name of the activity space which the user
is entering.sessionManager
- Pass the current user's ISessionManagerapplication
- Pass the IApplicationpublic static void ClearErrorsRequiringASeparateDisplayPage(ISessionManager sessionManager, IApplication application, AActivitySpace space, boolean bForThisAs, boolean bIncludeAdminErrors)
sessionManager
- application
- space
- bForThisAs
- bIncludeAdminErrors
- public static boolean GetDisplayAdminErrors(AActivitySpace space)
space
- AActivitySpace
public static boolean GetDisplayAdminErrors(java.lang.Object session)
Object
- session
public static IXPEnumerator GetErrors(ISessionManager sessionManager, IApplication application)
sessionManager
- Pass the current user's ISessionManagerapplication
- Pass the IApplication
public static IXPEnumerator GetErrors(ISessionManager sessionManager, IApplication application, AActivitySpace space, boolean bForThisAs, boolean bIncludeAdminErrors)
sessionManager
- Pass the current user's ISessionManagerapplication
- Pass the IApplicationactivitySpace
- Pass the activity space for which you wish
to obtain appropriate errors.bForThisSpace
- Pass a boolean value indicating if you wish to obtain
only errors associated with the passed activity space. If you pass true,
you will also obtain those errors not associated with any activity space,
you will only not obtain those errors associated with another activity
space. If you pass false, you will obtain all errors for this user.bIncludeAdminErrors
- Pass a boolean indicating whether or not you
wish to include errors for admin users. Use
ErrorHanlder.GetDisplayAdminErrors() to obtain the correct value for this
parameter.
public static boolean IsErrorPageRequired(ISessionManager sessionManager, IApplication application, boolean bIncludeAdminErrors)
sessionManager
- Pass the current user's ISessionManagerapplication
- Pass the IApplication
public static void RaiseError(UIError error, ISessionManager sessionManager, IApplication application)
error
- Pass a UIError object.sessionManager
- Pass an ISessionManagerapplication
- Pass an IApplication
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |