dtw.webmail.model
Interface JwmaError

All Known Implementing Classes:

JwmaException

public interface JwmaError

An interface defining the contract for interaction with the JwmaError model.

The JwmaError allows a view programmer to obtain information about an error to display it in free style and in any language. Note that the description will be in the language of the errormessages.properties file.

Version:

0.9.7 07/02/2003

Author:

Dieter Wimberger

Method Summary

java.lang.String[]	getDescriptions() Returns an String[] containing the keys to the locale specific error descriptions.
java.lang.String	getExceptionTrace() Returns a String representing the Errors embedded exception stack trace.
boolean	hasException() Tests if the error has an embedded exception.
boolean	isDisplayed() Tests if the error has been displayed.
boolean	isInlineError() Tests if the error is an inline error.
void	setDisplayed(boolean b) Set's the flag that stores if an error has been displayed.

Method Detail

isInlineError

public boolean isInlineError()

Tests if the error is an inline error.

An inline error should be displayed within the same view and not on the error view.

Returns:

true if it is an inline error, false otherwise.

isDisplayed

public boolean isDisplayed()

Tests if the error has been displayed.

Returns:

true if it was displayed, false otherwise.

setDisplayed

public void setDisplayed(boolean b)

Set's the flag that stores if an error has been displayed.

Parameters:

b - true if it was displayed, false otherwise.

getDescriptions

public java.lang.String[] getDescriptions()

Returns an String[] containing the keys to the locale specific error descriptions.

Returns:

an array of strings containing the error description keys.

hasException

public boolean hasException()

Tests if the error has an embedded exception.

Returns:

true if error has an embedded exception, false otherwise.

getExceptionTrace

public java.lang.String getExceptionTrace()

Returns a String representing the Errors embedded exception stack trace.

Returns:

the error's embedded exception stacktrace as String.