org.tentackle.swing.rdc

Interface InteractiveError

All Known Implementing Classes:

DefaultInteractiveError

public interface InteractiveError

Description of an error.

InteractiveErrors provide a semantic link between the data- and the presentation-layer. Usually, the data is verified at the data-layer and then decorated at the presentation-layer by examining the error (e.g. assign a GUI-component).
The TooltipAndErrorPanel is able to deal with a list of InteractiveErrors.

Author:

harald

Method Summary

Modifier and Type	Method and Description
String	getErrorCode() Gets the optional error code.
FormComponent	getFormComponent() Gets the related swing GUI-component.
org.tentackle.log.Logger.Level	getLevel() Gets the severity level.
String	getText() Gets the error message.
Object	getUiComponent() Gets the related GUI-component.
org.tentackle.validate.ValidationResult	getValidationResult() Gets the optional validation result.
void	setErrorCode(String errorCode) Sets the optional error code.
void	setLevel(org.tentackle.log.Logger.Level level) Sets the severity level.
void	setText(String text) Sets the error message.
void	setUiComponent(Object uiComponent) Sets the related GUI-component.
void	setValidationResult(org.tentackle.validate.ValidationResult validationResult) Sets the optional validation result.
void	showComponent() Shows the component to the user. The default implementation invokes FormComponent.requestFocusLater().

Method Detail

getLevel

org.tentackle.log.Logger.Level getLevel()

Gets the severity level.

Returns:

one of Logger.Level.WARNING or Logger.Level.SEVERE

getText

String getText()

Gets the error message.

Returns:

the error text

getErrorCode

String getErrorCode()

Gets the optional error code.

Returns:

the error code

getFormComponent

FormComponent getFormComponent()

Gets the related swing GUI-component.

Returns:

the component, null if none or guiComponent is not a FormComponent.

getUiComponent

Object getUiComponent()

Gets the related GUI-component. Can be anything, depending on the presentation layer.

Returns:

the component, null if none

showComponent

void showComponent()

Shows the component to the user.
The default implementation invokes FormComponent.requestFocusLater().

Applications may override this method to switch tabs, point to rows in tables, etc...

getValidationResult

org.tentackle.validate.ValidationResult getValidationResult()

Gets the optional validation result.

Returns:

the result, null if none

setErrorCode

void setErrorCode(String errorCode)

Sets the optional error code.

Parameters:

errorCode - the error code.

setLevel

void setLevel(org.tentackle.log.Logger.Level level)

Sets the severity level.

Parameters:

level - usually one of Logger.Level.WARNING or Logger.Level.SEVERE

setText

void setText(String text)

Sets the error message.

Parameters:

text - the error text

setUiComponent

void setUiComponent(Object uiComponent)

Sets the related GUI-component. Can be anything, depending on the presentation layer.

Parameters:

uiComponent - the component, null if none

setValidationResult

void setValidationResult(org.tentackle.validate.ValidationResult validationResult)

Sets the optional validation result.

Parameters:

validationResult - the result