net.sf.mmm.util.validation.api

Interface ValidationFailure

All Superinterfaces:

AttributeReadMessage, AttributeReadMessageCode, AttributeReadUuid, Message, Serializable

All Known Implementing Classes:

AbstractValidationFailure, ComposedValidationFailure, SimpleValidationFailure, ValidationFailureImpl

public interface ValidationFailure
extends Message

This is the interface for a failure of a validation.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from interface net.sf.mmm.util.lang.api.Message

TYPE_INFORMATION, TYPE_TECHNICAL_ERROR, TYPE_USER_ERROR, TYPE_VALIDATION_FAILURE, TYPE_WARNING

Method Summary

Modifier and Type	Method and Description
String	getCode() This method gets the code of this ValidationFailure.
String	getMessage() This method gets the message of the validation failure.
String	getMessage(Locale locale) This method gets the message localized for the given Locale.
String	getSource() This method gets the (optional) source of the validation.

Methods inherited from interface net.sf.mmm.util.lang.api.Message

getDetails, getType, getUuid

Method Detail

getSource

String getSource()

This method gets the (optional) source of the validation. It describes the origin of the given value. This may be the filename where the value was read from, an XPath where the value was located in an XML document, etc. It can be used to enrich messages displayed to end-users. This will help to find the problem easier.

Specified by:

getSource in interface Message

Returns:

the source or null if NOT available.

getMessage

String getMessage()

This method gets the message of the validation failure. This is a localized text displayed to end-users. It should explain the reason of the failure in a understandable but short form.
Some examples are "This field may not be blank." or "This value has to be in the range from 5 to 9.". Depending on the usage the message may also contain the name of the field or other context information in order to determine the source of the problem.

Specified by:

getMessage in interface AttributeReadMessage

Returns:

the message.

See Also:

Throwable.getMessage(), NlsThrowable, Message

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 will behave like getMessage() ignoring the lcoale.

Specified by:

getMessage in interface Message

Parameters:

locale - is the Locale.

Returns:

the message.

getCode

String getCode()

This method gets the code of this ValidationFailure. The code is a stable identifier that indicates the type of the failure. It can be used for automated testing in order to make the test-cases independent from the actual message texts so they are maintainable and will not break e.g. if typos are fixed in the messages.

Specified by:

getCode in interface AttributeReadMessageCode

Returns:

the failure code.

See Also:

Throwable.getMessage(), NlsThrowable, Message