public.javadoc.org.spincast.core.validation.ValidationMessage.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation

Source code for the https://www.spincast.org website.

There is a newer version: 2.2.0







ValidationMessage (org.spincast:spincast-framework 1.0.0 API)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.spincast.core.validation
Interface ValidationMessage






All Superinterfaces:
ToJsonObjectConvertible


All Known Implementing Classes:
ValidationMessageDefault




public interface ValidationMessage
extends ToJsonObjectConvertible
A validation message.











Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


JsonObject
convertToJsonObject()
Converts the message to a JsonObject object.



String
getCode()
The validation code.



ValidationHtmlEscapeType
getHtmlEscapeType()
How should the text be escaped when displayed in
 HTML?



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
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.







getHtmlEscapeType
ValidationHtmlEscapeType getHtmlEscapeType()
How should the text be escaped when displayed in
 HTML?







convertToJsonObject
JsonObject convertToJsonObject()
Converts the message to a JsonObject object.
 
 The resulting JsonObject object 
 is immutable.

Specified by:
convertToJsonObject in interface ToJsonObjectConvertible














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2019. All rights reserved.

Modifier and Type	Method and Description
`JsonObject`	`convertToJsonObject()` Converts the message to a `JsonObject` object.
`String`	`getCode()` The validation code.
`ValidationHtmlEscapeType`	`getHtmlEscapeType()` How should the text be escaped when displayed in HTML?
`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`	`isSuccess()` Returns `true` if the message level is SUCCESS.
`boolean`	`isWarning()` Returns `true` if the message level is WARNING.