Interface ValidatorConfig

The ValidatorType used by the ValidatorFactory. Leave it null or undefined to use the built-in Validator class.

Provides the error code associated with this instance. When unassigned, the Validator uses the ConditionType as the error code.

ConditionConfig that allows the ConditionFactory to provide the Condition. Like all Configs in this system, this is expected to be immutable. Only use this when ConditionCreator is null.

Use to create the Condition instance yourself, especially to support implementations of ICondition that don't implement IConditionCore. Only use this when ConditionConfig is null.

Param: requester

Returns

When false, validation is never run. This supersedes the Enabler too. Values:

• true/false obviously.
• undefined - tells the Validator to treat it as true. (Its value will not be updated as we want this to be immutable while the Config is assigned to the host.)
• function - Provide a function that will return true or false, given the Validator as a parameter.

Resolves the Severity for when the Condition evaluates as NoMatch. Values:

• ValidationSeverity enum. Set to Severe by default for conditions with Category=Require and DataTypeCheck.
• Undefined - tells the Validator to treat it as Error.
• function - Provide a function that will return the ValidationSeverity, given the Validator as a parameter.

The error message "template" that will appear on screen when the condition is NoMatch. It can use tokens, which are resolved with current data at the time of validation. Tokens are resolved with Services.MessageTokenResolver. It should already be localized, except for the tokens. It can contain HTML tags if the platform supports them. In that case, be sure to use HTML encoded characters. The string shown to the actual user is stored in ValueHostInstanceState.errorMessage. Values:

• String - The error message with tokens and optional HTML tags.
• function - Returns the error message, given the Validator, allowing you to replace or customize the message during validation. The function must return a string, although an empty string is valid. When localization is setup in ErrorMessagel10n, the value can be set to '' so long as your TextLocalizerService ALWAYS returns the text. Otherwise, this should be the fallback. If you have setup defaults for error messages with TextLocalizerService, leave this null to use the default. Any value here supersedes default error messages.

Localization key for errorMessage. Its value will be matched to an entry made to ValidationServices.TextLocalizerService, specific to the active culture. If setup and no entry was found in TextLocalizerService, the value from the errorMessage property is used.

Variation of the errorMessage intended to be displayed in a Validation Summary area. A summary is usually not near the field with the error. As a result, it helps to shape the message differently, usually by including the Label token. "{Label} is required." Values:

• undefined and null - use the errorMessage as the template.
• string - The error message with tokens and optional HTML tags.
• function - Returns the error message, given the Validator, allowing you to replace or customize the message during validation. The function must return a string, although an empty string is valid. When localization is setup in SummaryMessagel10n, the value can be set to '' so long as your TextLocalizerService ALWAYS returns the text. Otherwise, this should be the fallback. If you have setup defaults for error messages with TextLocalizerService, leave this null to use the default. Any value here supersedes default error messages.

Localization key for summaryMessage. Its value will be matched to an entry made to ValidationServices.TextLocalizerService, specific to the active culture. If setup and no entry was found in TextLocalizerService, the value from the errorMessage property is used.