com.plumtree.uiinfrastructure.errordisplay
Class ErrorDisplayHelper

java.lang.Object
  com.plumtree.uiinfrastructure.errordisplay.ErrorDisplayHelper

public class ErrorDisplayHelper
extends java.lang.Object

This helper class allows you to retrieve and display UI error messages. It is implemented as an object rather than static methods so that it can be extended and re-used if necessary.

Constructor Summary

ErrorDisplayHelper(AActivitySpace _currentAS, IXPEnumerator _errors)
This helper object displays UI errors.

Method Summary

HTMLElement	DisplayErrors() This method displays multiple errors with HTML formatting and images.
java.lang.String	GetFirstErrorExtendedText() This method gets the extended error message for the first UI error.
java.lang.String	GetFirstErrorText() This method gets the base error string for the first UI error and it does not clears all errors.
void	SetDisplaySeparatePageErrors(boolean _bDisplaySeparatePageErrors) This method sets whether or not this helper method will attempt to display errors that are configured to display on a separate page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ErrorDisplayHelper

public ErrorDisplayHelper(AActivitySpace _currentAS,
                          IXPEnumerator _errors)

This helper object displays UI errors.

Parameters:

_currentAS - The current Activity Space.

_errors - The current UI errors.

Method Detail

SetDisplaySeparatePageErrors

public void SetDisplaySeparatePageErrors(boolean _bDisplaySeparatePageErrors)

This method sets whether or not this helper method will attempt to display errors that are configured to display on a separate page. This setting only applies to the full HTML display, not the simple GetFirstErrorText method.

Parameters:

_bDisplaySeparatePageErrors - whether or not this helper object should display errors that are configured to display on a separate page.

GetFirstErrorText

public java.lang.String GetFirstErrorText()

This method gets the base error string for the first UI error and it does not clears all errors. It does not handle error exceptions or extended error messages.

Returns:

String the first error string. Empty string if there are no errors.

GetFirstErrorExtendedText

public java.lang.String GetFirstErrorExtendedText()

This method gets the extended error message for the first UI error. It does not handle error exceptions.

Returns:

String the first extended error string. Empty string if there are no errors.

DisplayErrors

public HTMLElement DisplayErrors()

This method displays multiple errors with HTML formatting and images. It also displays error exceptions and extended error messages. After displaying the errors, it will clear all errors.

Returns:

HTMLElement the formatted error HTML.