net.sf.mmm.util.lang.api

Interface Message

All Superinterfaces:

AttributeReadMessage, AttributeReadMessageCode, AttributeReadUuid, Serializable

All Known Subinterfaces:

ValidationFailure

All Known Implementing Classes:

AbstractErrorMessage, AbstractMessage, AbstractValidationFailure, ComposedValidationFailure, ErrorMessage, InformationMessage, ValidationFailureImpl, ValidationFailureSuccess, WarningMessage

public interface Message
extends Serializable, AttributeReadUuid, AttributeReadMessage, AttributeReadMessageCode

This is the interface for a message that gets displayed to an end-user.

Since:

3.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_INFORMATION The type for an information.
static String	TYPE_TECHNICAL_ERROR The type for a technical error.
static String	TYPE_USER_ERROR The type for a user error.
static String	TYPE_VALIDATION_FAILURE The type for a validation failure.
static String	TYPE_WARNING The type for a warning.

Method Summary

Modifier and Type	Method and Description
String	getDetails() This method gets optional details for this message.
String	getMessage(Locale locale) This method gets the message localized for the given Locale.
String	getSource() This method gets the (optional) source of the message.
String	getType() This method gets the type of this Message.
UUID	getUuid() This method gets the UUID of this object.

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeReadMessage

getMessage

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeReadMessageCode

getCode

Field Detail

TYPE_TECHNICAL_ERROR

static final String TYPE_TECHNICAL_ERROR

The type for a technical error.

See Also:

NlsThrowable.isTechnical(), Constant Field Values

TYPE_USER_ERROR

static final String TYPE_USER_ERROR

The type for a user error.

See Also:

NlsThrowable.isForUser(), Constant Field Values

TYPE_VALIDATION_FAILURE

static final String TYPE_VALIDATION_FAILURE

The type for a validation failure.

See Also:

Constant Field Values

TYPE_WARNING

static final String TYPE_WARNING

The type for a warning.

See Also:

Constant Field Values

TYPE_INFORMATION

static final String TYPE_INFORMATION

The type for an information.

See Also:

Constant Field Values

Method Detail

getSource

String getSource()

This method gets the (optional) source of the message. E.g. the name or a field or file that is invalid. It can be used to enrich messages displayed to end-users. This will help to find the problem easier.

Returns:

the source or null if NOT available.

getMessage

String getMessage(Locale locale)

This method gets the message localized for the given Locale.
ATTENTION:
This method is designed for server applications with NLS. On client side (e.g. for GWT clients) only a single locale may be supported at a time and this method may behave like AttributeReadMessage.getMessage() ignoring the Locale.

Parameters:

locale - is the Locale.

Returns:

the message.

getDetails

String getDetails()

This method gets optional details for this message. E.g. in case of an exception this can be the stacktrace.

Returns:

the details or null if no additional details are available.

getType

String getType()

This method gets the type of this Message. This should be one of the following options:

• "ValidationFailure" - for a ValidationFailure.
• "UserError" - for an error caused by the end-user (e.g. by providing invalid data). Unlike TYPE_VALIDATION_FAILURE this is an actual error that has been detected after a successful validation.
• "TechnicalError" - for an error related to a technical problem (e.g. programming failure such as NullPointerException or operational error like ConnectException).
• "Warning" - for a warning such as "The hit-list for your query has been truncated."). In such case it should be possible to continue the use-case or operation normally.
• "Information" - for additional information - e.g. a hint.

Returns:

the message type.

getUuid

UUID getUuid()

This method gets the UUID of this object. When the object is created, a UUID is generated. In case the object is created from another object that already has a UUID, the existing UUID will be used (e.g. for chained exceptions).
The UUID will appear in a stacktrace but NOT in the message. It will therefore be written to log-files if the NlsThrowable is logged. If you supply the UUID to the end-user in an error panel or popup (see Message), he can provide it with the problem report so an administrator or software developer can easily find the stacktrace in the log-files.

Specified by:

getUuid in interface AttributeReadUuid

Returns:

the UUID if this Message. Will typically only be available if type is TYPE_TECHNICAL_ERROR or TYPE_USER_ERROR. Will be null if not available.