org.spincast.core.validation

Interface ValidationMessage

All Superinterfaces:

ToJsonObjectConvertible

All Known Implementing Classes:

ValidationMessageDefault

public interface ValidationMessage
extends ToJsonObjectConvertible

A validation message.

Method Summary

Modifier and Type	Method and Description
JsonObject	convertToJsonObject() Converts the message to a JsonObject object.
String	getCode() The validation code.
String	getText() The text of the message.
ValidationLevel	getValidationLevel() The validation level of thr message : ERROR, WARNING or SUCCESS.
boolean	isError() Returns true if the message level is ERROR.
boolean	isHtmlEscape() Must the text be escaped when displayed in HTML?
boolean	isSuccess() Returns true if the message level is SUCCESS.
boolean	isWarning() Returns true if the message level is WARNING.

Method Detail

getValidationLevel

ValidationLevel getValidationLevel()

The validation level of thr message : ERROR, WARNING or SUCCESS.

isWarning

boolean isWarning()

Returns true if the message level is WARNING.

isSuccess

boolean isSuccess()

Returns true if the message level is SUCCESS.

isError

boolean isError()

Returns true if the message level is ERROR.

getCode

String getCode()

The validation code.

getText

String getText()

The text of the message.

isHtmlEscape

boolean isHtmlEscape()

Must the text be escaped when displayed in HTML?

Defaultsa to true.

convertToJsonObject

JsonObject convertToJsonObject()

Converts the message to a JsonObject object.

The resulting JsonObject object is immutable.

Specified by:

convertToJsonObject in interface ToJsonObjectConvertible