|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.validation.result.ValidationError
public class ValidationError
Constructor Summary | |
---|---|
init()
|
Method Summary | |
---|---|
IValidationError |
configure(string message, string field, [string rejectedValue], [string validationType], [string validationData])
Configure method, which can do setters for all required error params |
struct |
getErrorMetadata()
Get the error metadata |
string |
getField()
Get the error field |
struct |
getMemento()
Get the error representation |
string |
getMessage()
Get the error message |
any |
getRejectedValue()
Get the rejected value |
string |
getValidationData()
Get the error validation data |
string |
getValidationType()
Get the error validation type |
IValidationError |
setErrorMetadata(any data)
Set error metadata that can be used in i18n message replacements or in views |
IValidationError |
setField(string field)
Set the field |
IValidationError |
setMessage(string message)
Set the error message |
IValidationError |
setRejectedValue(any value)
Set the rejected value |
IValidationError |
setValidationData(any data)
Set the validator data |
IValidationError |
setValidationType(any validationType)
Set the validator type name that rejected |
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init()
Method Detail |
---|
public IValidationError configure(string message, string field, [string rejectedValue], [string validationType], [string validationData])
message
- The required error messagefield
- The required field that case the exceptionrejectedValue
- The optional rejected valuevalidationType
- The name of the rejected validatorvalidationData
public struct getErrorMetadata()
public string getField()
getField
in interface
IValidationError
public struct getMemento()
public string getMessage()
getMessage
in interface
IValidationError
public any getRejectedValue()
getRejectedValue
in interface
IValidationError
public string getValidationData()
getValidationData
in interface
IValidationError
public string getValidationType()
getValidationType
in interface
IValidationError
public IValidationError setErrorMetadata(any data)
data
- The name-value pairs of data to store in this error.public IValidationError setField(string field)
setField
in interface
IValidationError
field
public IValidationError setMessage(string message)
setMessage
in interface
IValidationError
message
- The error messagepublic IValidationError setRejectedValue(any value)
setRejectedValue
in interface
IValidationError
value
- The rejected valuepublic IValidationError setValidationData(any data)
setValidationData
in interface
IValidationError
data
- The data of the validatorpublic IValidationError setValidationType(any validationType)
setValidationType
in interface
IValidationError
validationType
- The name of the rejected validator
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |