|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.interfacecoldbox.system.validation.result.IValidationResult
public interface IValidationResult
Method Summary | |
---|---|
IValidationResult |
addError(IValidationError error)
Add errors into the result object |
IValidationResult |
clearErrors()
Clear All errors |
array |
getAllErrors([string field])
Get the Errors Array, which is an array of error messages (strings) |
numeric |
getErrorCount([string field])
Get how many errors you have |
coldbox.system.validation.result.IValidationError[] |
getFieldErrors(string field)
Get an error object for a specific field that failed |
struct |
getResultMetadata()
Get a collection of metadata about the validation results |
string |
getTargetName()
Get the name of the target object that got validated |
string |
getValidationLocale()
Get the validation locale |
boolean |
hasErrors([string field])
Determine if the results had error or not |
boolean |
hasLocale()
has locale information |
IValidationResult |
setLocale(string locale)
Set the validation locale |
IValidationResult |
setResultMetadata(struct data)
Set a collection of metadata into the results object |
IValidationResult |
setTargetName(string name)
Set the validation target object name |
Methods inherited from class WEB-INF.cftags.interface |
---|
|
Method Detail |
---|
public IValidationResult addError(IValidationError error)
error
- The validation error to add into the results objectpublic IValidationResult clearErrors()
public array getAllErrors([string field])
field
- The field to use to filter the error messages on (optional)public numeric getErrorCount([string field])
field
- The field to count on (optional)public coldbox.system.validation.result.IValidationError[] getFieldErrors(string field)
field
- The field to return error objects onpublic struct getResultMetadata()
public string getTargetName()
public string getValidationLocale()
public boolean hasErrors([string field])
field
- The field to count on (optional)public boolean hasLocale()
public IValidationResult setLocale(string locale)
locale
public IValidationResult setResultMetadata(struct data)
data
public IValidationResult setTargetName(string name)
name
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |