GormValidationApi (GORM for MongoDB

org.grails.datastore.gorm.GormValidationApi

```
@groovy.transform.CompileStatic
class GormValidationApi<D>
extends AbstractGormApi<D>
```
Methods used for validating GORM instances.
Authors:
Graeme Rocher
Type Parameters:
D - the entity/domain class
Since:
1.0

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`ARGUMENT_DEEP_VALIDATE`
`private org.grails.datastore.gorm.support.BeforeValidateHelper`	`beforeValidateHelper`
`protected org.springframework.context.ApplicationEventPublisher`	`eventPublisher`
`protected boolean`	`hasDatastore`
`private org.springframework.validation.Validator`	`internalValidator`
`protected MappingContext`	`mappingContext`

Properties Summary

Properties
Type	Name and description
`org.grails.datastore.gorm.support.BeforeValidateHelper`	`beforeValidateHelper`
`org.springframework.validation.Errors`	`errors`
`org.springframework.validation.Validator`	`validator`

Constructor Summary

Constructors
Constructor and description
`GormValidationApi (java.lang.Class<D> persistentClass, Datastore datastore)`
`GormValidationApi (java.lang.Class<D> persistentClass, MappingContext mappingContext, org.springframework.context.ApplicationEventPublisher eventPublisher)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`clearErrors(D instance)` Clears any errors that exist on an instance
	`protected ValidationEvent`	`createValidationEvent(java.lang.Object target)`
	`private boolean`	`doValidate(D instance, java.util.Map arguments, java.util.List fields)`
	`private ValidationErrors`	`filterErrors(ValidationErrors errors, java.util.Set validatedFields, java.lang.Object target)`
	`private void`	`fireEvent(java.lang.Object target, java.util.List fields)` Fire the validation event.
	`org.springframework.validation.Errors`	`getErrors(D instance)` Obtains the errors for an instance
	`org.springframework.validation.Validator`	`getValidator()`
	`boolean`	`hasErrors(D instance)` Tests whether an instance has any errors
	`protected org.springframework.validation.Errors`	`resetErrors(D instance)`
	`void`	`setErrors(D instance, org.springframework.validation.Errors errors)` Sets the errors for an instance
	`void`	`setValidator(org.springframework.validation.Validator validator)`
	`boolean`	`validate(D instance, java.util.Map arguments)` Validates an instance for the given arguments
	`boolean`	`validate(D instance, java.util.List fields)` Validates an instance
	`boolean`	`validate(D instance)` Validates an instance

- Field Detail
  - public static final java.lang.String ARGUMENT_DEEP_VALIDATE
  - private org.grails.datastore.gorm.support.BeforeValidateHelper beforeValidateHelper
  - protected final org.springframework.context.ApplicationEventPublisher eventPublisher
  - protected final boolean hasDatastore
  - private org.springframework.validation.Validator internalValidator
  - protected final MappingContext mappingContext
- Property Detail
  - org.grails.datastore.gorm.support.BeforeValidateHelper beforeValidateHelper
  - org.springframework.validation.Errors errors
  - org.springframework.validation.Validator validator
- Constructor Detail
  - GormValidationApi(java.lang.Class<D> persistentClass, Datastore datastore)
  - GormValidationApi(java.lang.Class<D> persistentClass, MappingContext mappingContext, org.springframework.context.ApplicationEventPublisher eventPublisher)
- Method Detail
  - void clearErrors(D instance)
    
    Clears any errors that exist on an instance
    Parameters:
    instance - The instance
  - protected ValidationEvent createValidationEvent(java.lang.Object target)
  - private boolean doValidate(D instance, java.util.Map arguments, java.util.List fields)
  - private ValidationErrors filterErrors(ValidationErrors errors, java.util.Set validatedFields, java.lang.Object target)
  - private void fireEvent(java.lang.Object target, java.util.List fields)
    
    Fire the validation event.
    Parameters:
    target - The target instance.
    fields - The list of fields being validated, or null.
  - org.springframework.validation.Errors getErrors(D instance)
    
    Obtains the errors for an instance
    Parameters:
    instance - The instance to obtain errors for
    Returns:
    The org.springframework.validation.Errors instance
  - org.springframework.validation.Validator getValidator()
  - boolean hasErrors(D instance)
    
    Tests whether an instance has any errors
    Parameters:
    instance - The instance
    Returns:
    True if errors exist
  - protected org.springframework.validation.Errors resetErrors(D instance)
  - void setErrors(D instance, org.springframework.validation.Errors errors)
    
    Sets the errors for an instance
    Parameters:
    instance - The instance
    errors - The errors
  - void setValidator(org.springframework.validation.Validator validator)
  - boolean validate(D instance, java.util.Map arguments)
    
    Validates an instance for the given arguments
    Parameters:
    instance - The instance to validate
    arguments - The arguments to use
    Returns:
    True if the instance is valid
  - boolean validate(D instance, java.util.List fields)
    
    Validates an instance
    Parameters:
    instance - The instance to validate
    fields - The list of fields to validate
    Returns:
    True if the instance is valid
  - boolean validate(D instance)
    
    Validates an instance
    Parameters:
    instance - The instance to validate
    Returns:
    True if the instance is valid

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class GormValidationApi<D>

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Field Detail

public static final java.lang.String ARGUMENT_DEEP_VALIDATE

private org.grails.datastore.gorm.support.BeforeValidateHelper beforeValidateHelper

protected final org.springframework.context.ApplicationEventPublisher eventPublisher

protected final boolean hasDatastore

private org.springframework.validation.Validator internalValidator

protected final MappingContext mappingContext

Property Detail

org.grails.datastore.gorm.support.BeforeValidateHelper beforeValidateHelper

org.springframework.validation.Errors errors

org.springframework.validation.Validator validator

Constructor Detail

GormValidationApi(java.lang.Class<D> persistentClass, Datastore datastore)

GormValidationApi(java.lang.Class<D> persistentClass, MappingContext mappingContext, org.springframework.context.ApplicationEventPublisher eventPublisher)

Method Detail

void clearErrors(D instance)

protected ValidationEvent createValidationEvent(java.lang.Object target)

private boolean doValidate(D instance, java.util.Map arguments, java.util.List fields)

private ValidationErrors filterErrors(ValidationErrors errors, java.util.Set validatedFields, java.lang.Object target)

private void fireEvent(java.lang.Object target, java.util.List fields)

org.springframework.validation.Errors getErrors(D instance)

org.springframework.validation.Validator getValidator()

boolean hasErrors(D instance)

protected org.springframework.validation.Errors resetErrors(D instance)

void setErrors(D instance, org.springframework.validation.Errors errors)

void setValidator(org.springframework.validation.Validator validator)

boolean validate(D instance, java.util.Map arguments)

boolean validate(D instance, java.util.List fields)

boolean validate(D instance)