com.vaadin.terminal
Interface ErrorMessage

All Superinterfaces:
Serializable
All Known Implementing Classes:
AbstractErrorMessage, CompositeErrorMessage, SystemError, UserError

public interface ErrorMessage
extends Serializable

Interface for rendering error messages to terminal. All the visible errors shown to user must implement this interface.

Since:
3.0
Version:
7.0.0.alpha3
Author:
Vaadin Ltd.

Nested Class Summary
static class ErrorMessage.ErrorLevel
           
 
Field Summary
static ErrorMessage.ErrorLevel CRITICAL
          Deprecated. from 7.0, use ErrorMessage.ErrorLevel.CRITICAL instead    
static ErrorMessage.ErrorLevel ERROR
          Deprecated. from 7.0, use ErrorMessage.ErrorLevel.ERROR instead    
static ErrorMessage.ErrorLevel INFORMATION
          Deprecated. from 7.0, use ErrorMessage.ErrorLevel.INFORMATION instead    
static ErrorMessage.ErrorLevel SYSTEMERROR
          Deprecated. from 7.0, use ErrorMessage.ErrorLevel.SYSTEMERROR instead    
static ErrorMessage.ErrorLevel WARNING
          Deprecated. from 7.0, use ErrorMessage.ErrorLevel.WARNING instead    
 
Method Summary
 ErrorMessage.ErrorLevel getErrorLevel()
          Gets the errors level.
 String getFormattedHtmlMessage()
          Returns the HTML formatted message to show in as the error message on the client.
 

Field Detail

SYSTEMERROR

@Deprecated
static final ErrorMessage.ErrorLevel SYSTEMERROR
Deprecated. from 7.0, use ErrorMessage.ErrorLevel.SYSTEMERROR instead    

CRITICAL

@Deprecated
static final ErrorMessage.ErrorLevel CRITICAL
Deprecated. from 7.0, use ErrorMessage.ErrorLevel.CRITICAL instead    

ERROR

@Deprecated
static final ErrorMessage.ErrorLevel ERROR
Deprecated. from 7.0, use ErrorMessage.ErrorLevel.ERROR instead    

WARNING

@Deprecated
static final ErrorMessage.ErrorLevel WARNING
Deprecated. from 7.0, use ErrorMessage.ErrorLevel.WARNING instead    

INFORMATION

@Deprecated
static final ErrorMessage.ErrorLevel INFORMATION
Deprecated. from 7.0, use ErrorMessage.ErrorLevel.INFORMATION instead    
Method Detail

getErrorLevel

ErrorMessage.ErrorLevel getErrorLevel()
Gets the errors level.

Returns:
the level of error as an integer.

getFormattedHtmlMessage

String getFormattedHtmlMessage()
Returns the HTML formatted message to show in as the error message on the client. This method should perform any necessary escaping to avoid XSS attacks. TODO this API may still change to use a separate data transfer object

Returns:
HTML formatted string for the error message
Since:
7.0


Copyright © 2000-2011 Vaadin Ltd. All Rights Reserved.