org.opencms.gwt
Interface I_CmsFormValidator

All Known Implementing Classes:

CmsDefaultFormValidator

public interface I_CmsFormValidator

Interface for handling the server-side validation of a whole form.

Since:

8.0.0

Method Summary

java.util.Map<java.lang.String,CmsValidationResult>

validate(CmsObject cms, java.util.Map<java.lang.String,CmsValidationQuery> queries, java.util.Map<java.lang.String,java.lang.String> values, java.lang.String config) Validates the form and returns the validation result.

Method Detail

validate

java.util.Map<java.lang.String,CmsValidationResult> validate(CmsObject cms,
                                                             java.util.Map<java.lang.String,CmsValidationQuery> queries,
                                                             java.util.Map<java.lang.String,java.lang.String> values,
                                                             java.lang.String config)
                                                             throws java.lang.Exception

Validates the form and returns the validation result.

Implementations of this interface may or may not use the validators in the validation queries passed as an argument.

Parameters:

cms - the CMS context

queries - the validation queries for the form fields, indexed by form field key

values - the form field values

config - the configuration for the form validator

Returns:

a map of the validation results, indexed by form field key

Throws:

java.lang.Exception - if something goes wrong