org.cyclos.utils

Class ValidationResult

java.lang.Object

org.cyclos.utils.ValidationResult

All Implemented Interfaces:

java.io.Serializable

public class ValidationResult
extends java.lang.Object
implements java.io.Serializable

Contains the results of a validation process. There might have general errors or property-specific errors.

Author:

luis

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CUSTOM_FIELD_ERRORS
static java.lang.String	GENERAL_ERRORS
static java.lang.String	PROPERTY_ERRORS

Constructor Summary

Constructors

Constructor and Description
ValidationResult()
ValidationResult(java.lang.String error) Constructs a ValidationResult with a single general error
ValidationResult(java.lang.String name, java.lang.String error) Constructs a ValidationResult with a single property error

Method Summary

Modifier and Type	Method and Description
void	addCustomFieldError(java.lang.String field, java.lang.String error) Adds a custom field error
void	addGeneralError(java.lang.String error) Adds a general error
void	addPropertyError(java.lang.String property, java.lang.String error) Adds a property error
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getCustomFieldErrors()
java.lang.String	getFirstError() Returns the first validation error message, if any
java.util.List<java.lang.String>	getGeneralErrors()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getPropertyErrors()
boolean	hasCustomFieldErrors() Checks if there are any custom field errors
boolean	hasErrors() Checks if there are any errors, either general or property-specific
boolean	hasGeneralErrors() Checks if there are any general errors
boolean	hasPropertyErrors() Checks if there are any property errors
void	merge(ValidationResult other, java.lang.String propertyNamePrefix) Merges the given ValidationResult with this, optionally prefixing the other property error names with the given prefix
void	setCustomFieldErrors(java.util.Map<java.lang.String,java.util.List<java.lang.String>> customFieldErrors)
void	setGeneralErrors(java.util.List<java.lang.String> generalErrors)
void	setPropertyErrors(java.util.Map<java.lang.String,java.util.List<java.lang.String>> propertyErrors)
void	throwIfHasErrors() Throws a ValidationException with this result if there are any errors, or returns silently if no errors.
java.lang.String	toHtmlString(java.lang.String errorTitle)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

GENERAL_ERRORS

public static final java.lang.String GENERAL_ERRORS

See Also:

Constant Field Values

PROPERTY_ERRORS

public static final java.lang.String PROPERTY_ERRORS

See Also:

Constant Field Values

CUSTOM_FIELD_ERRORS

public static final java.lang.String CUSTOM_FIELD_ERRORS

See Also:

Constant Field Values

Constructor Detail

ValidationResult

public ValidationResult()

ValidationResult

public ValidationResult(java.lang.String error)

Constructs a ValidationResult with a single general error

ValidationResult

public ValidationResult(java.lang.String name,
                        java.lang.String error)

Constructs a ValidationResult with a single property error

Method Detail

addCustomFieldError

public void addCustomFieldError(java.lang.String field,
                                java.lang.String error)

Adds a custom field error

addGeneralError

public void addGeneralError(java.lang.String error)

Adds a general error

addPropertyError

public void addPropertyError(java.lang.String property,
                             java.lang.String error)

Adds a property error

getCustomFieldErrors

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getCustomFieldErrors()

getFirstError

public java.lang.String getFirstError()

Returns the first validation error message, if any

getGeneralErrors

public java.util.List<java.lang.String> getGeneralErrors()

getPropertyErrors

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getPropertyErrors()

hasCustomFieldErrors

public boolean hasCustomFieldErrors()

Checks if there are any custom field errors

hasErrors

public boolean hasErrors()

Checks if there are any errors, either general or property-specific

hasGeneralErrors

public boolean hasGeneralErrors()

Checks if there are any general errors

hasPropertyErrors

public boolean hasPropertyErrors()

Checks if there are any property errors

merge

public void merge(ValidationResult other,
                  java.lang.String propertyNamePrefix)

Merges the given ValidationResult with this, optionally prefixing the other property error names with the given prefix

setCustomFieldErrors

public void setCustomFieldErrors(java.util.Map<java.lang.String,java.util.List<java.lang.String>> customFieldErrors)

setGeneralErrors

public void setGeneralErrors(java.util.List<java.lang.String> generalErrors)

setPropertyErrors

public void setPropertyErrors(java.util.Map<java.lang.String,java.util.List<java.lang.String>> propertyErrors)

throwIfHasErrors

public void throwIfHasErrors()
                      throws ValidationException

Throws a ValidationException with this result if there are any errors, or returns silently if no errors.

Throws:

ValidationException

toHtmlString

public java.lang.String toHtmlString(java.lang.String errorTitle)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object