com.canto.cumulus.server.esp.modules.validator

Interface ValidatorESP

All Superinterfaces:

BaseESP

public interface ValidatorESP
extends BaseESP

This interface needs to be implemented by a class that wants to act as a validator.

Since:

8.5

Method Summary

Methods

Modifier and Type	Method and Description
ValidatorConfigurator	createConfigurator(JPack configuration) Return a configurator instance that is initialized with the given data.
java.lang.String	getName(java.util.Locale locale) Returns the name for this validator.
java.lang.String	getUserInterfaceCheckboxText(java.util.Locale locale) Returns the text being displayed with the JCheckBox in the preferences dialog that enables or disabled the validator for the current field.
boolean	hasConfigurator() Returns whether this validator has some specific user interface for configuration
boolean	supportsField(GUID guid, int fieldType, int valueInterpretation) Returns whether the given field is supported for validation.
java.lang.String	validate(java.util.Locale locale, java.lang.Object item, java.lang.Object fieldDefinition, JPack configurationData) The actual worker method that should validate the field content of the given record to comply with the validation rules specified by the configuration data.

Methods inherited from interface com.canto.cumulus.server.esp.modules.BaseESP

getID

Method Detail

getName

java.lang.String getName(java.util.Locale locale)

Returns the name for this validator.

Parameters:

locale - the language to get the name for

Returns:

the validators name

supportsField

boolean supportsField(GUID guid,
                    int fieldType,
                    int valueInterpretation)

Returns whether the given field is supported for validation.

Parameters:

guid - GUID of the field to check

fieldType - field type of the field to check

valueInterpretation - value interpretation of the field to check

Returns:

true if the given field can be validated, false otherwise

getUserInterfaceCheckboxText

java.lang.String getUserInterfaceCheckboxText(java.util.Locale locale)

Returns the text being displayed with the JCheckBox in the preferences dialog that enables or disabled the validator for the current field.

Parameters:

locale - the language to get the text for

Returns:

text being displayed with the JCheckBox

hasConfigurator

boolean hasConfigurator()

Returns whether this validator has some specific user interface for configuration

Returns:

true if this validator has some specific user interface for configuration, false otherwise

createConfigurator

ValidatorConfigurator createConfigurator(JPack configuration)

Return a configurator instance that is initialized with the given data.

Parameters:

configuration - the configuration data

Returns:

the configurator instance

validate

java.lang.String validate(java.util.Locale locale,
                        java.lang.Object item,
                        java.lang.Object fieldDefinition,
                        JPack configurationData)

The actual worker method that should validate the field content of the given record to comply with the validation rules specified by the configuration data.

Parameters:

locale - The language to present the error with in case of a failed validation

item - The item to work on. Needs to be casted to Item for the actual work

fieldDefinition - The field definition of the field to work on. Needs to be casted to FieldDefinition for the actual work

configurationData - The pack containing the configuration previously configured using the ValidatorConfigurator instance of this validator

Returns:

The found validation error or null if the current value is valid