Package de.espirit.firstspirit.agency

Interface ValidationAgent

public interface ValidationAgent

Agent providing means to validate form data against defined rules.

Since:

5.0.8

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ValidationAgent.ValidationScope	Validation scope, either ValidationAgent.ValidationScope.SAVE or ValidationAgent.ValidationScope.RELEASE.

Field Summary

Fields

Modifier and Type	Field	Description
static final SpecialistType<ValidationAgent>	TYPE	Agent providing means to validate some store element against defined rules.

Method Summary

Modifier and Type	Method	Description
MultiFormValidationReport	validate(IDProvider element, ValidationAgent.ValidationScope scope)	Validate the data of the given element in given validation. Note: Child elements of the given element are not included in this validation and have to be validated separately, e.g., sections of a page.
MultiFormValidationReport	validate(FormData formData, Iterable<Language> languages, ValidationAgent.ValidationScope scope)	Validate the given data for the provided languages in given validation scope.

Field Details

TYPE

static final SpecialistType<ValidationAgent> TYPE

Agent providing means to validate some store element against defined rules.

Since:

5.0.8

Method Details

validate

MultiFormValidationReport validate(IDProvider element,
 ValidationAgent.ValidationScope scope)

Validate the data of the given element in given validation.
Note: Child elements of the given element are not included in this validation and have to be validated separately, e.g., sections of a page.

Parameters:

element - Element whose data will be checked.

scope - Scope for validation.

Returns:

A report on the validation results.

Since:

5.0.8

validate

MultiFormValidationReport validate(FormData formData,
 Iterable<Language> languages,
 ValidationAgent.ValidationScope scope)

Validate the given data for the provided languages in given validation scope.

Parameters:

formData - The form data to validate.

languages - The languages to be validated for.

scope - Scope for validation.

Returns:

A report on the validation results.

Since:

5.0.8