Class: RequiredValidator

Oracle® JavaScript Extension Toolkit (JET)
5.2.0
E97691-01

RequiredValidator extends oj.Validator

Version:

5.2.0

Since:

Module:

ojvalidation-base

Constructor

new RequiredValidator(options)

Constructs a RequiredValidator that ensures that the value provided is not empty

Parameters:

Name	Type	Argument	Description
`options`	oj.RequiredValidator.ValidatorOptions	<optional>	an object literal used to provide an optional hint and error message.

Methods

getHint() → {string|null}

A message to be used as hint, when giving a hint on the expected pattern. There is no default hint for this property.

Returns:

a hint message or null if no hint is available in the options

Type: string | null

validate(value) → {boolean}

Validates value to be non-empty

Parameters:

Name	Type	Description
`value`	Object \| string \| number	that is being validated

Throws:

when fails required-ness check

Type: Error

Returns:

true if validation was was successful the value is non-empty

Type: boolean

Type Definitions

ValidatorOptions

Properties:

Name Type Argument Description

hint string <optional> an optional hint text. There is no default hint provided by this validator.

Name	Type	Argument	Description
`hint`	string	<optional>	an optional hint text. There is no default hint provided by this validator.
`messageSummary`	string	<optional>	an optional custom error message summarizing the error. When not present, the default message summary is the resource defined with the key `oj-validator.required.summary`. The messageSummary string is passed as the 'pattern' parameter to oj.Translations.html#applyParameters. As stated in that documentation, if you are using a reserved character, you need to escape it with a dollar character ('$'). Tokens: {label} - this token can be used to substitute the label of the component at runtime. Example: "'{label}' Required"
`messageDetail`	string	<optional>	a custom error message used for creating detail part of message, when the value provided is empty. When not present, the default message detail is the resource defined with the key `oj-validator.required.detail`. The messageDetail string is passed as the 'pattern' parameter to oj.Translations.html#applyParameters. As stated in that documentation, if you are using a reserved character, you need to escape it with a dollar character ('$'). Tokens: {label} - this token can be used to substitute the label of the component at runtime. Example: "A value is required for the field '{label}'."

messageSummary

string

an optional custom error message summarizing the error. When not present, the default message summary is the resource defined with the key oj-validator.required.summary.

The messageSummary string is passed as the 'pattern' parameter to oj.Translations.html#applyParameters. As stated in that documentation, if you are using a reserved character, you need to escape it with a dollar character ('$').

Tokens: {label} - this token can be used to substitute the label of the component at runtime.

Example:
"'{label}' Required"

messageDetail

string

a custom error message used for creating detail part of message, when the value provided is empty. When not present, the default message detail is the resource defined with the key oj-validator.required.detail.

The messageDetail string is passed as the 'pattern' parameter to oj.Translations.html#applyParameters. As stated in that documentation, if you are using a reserved character, you need to escape it with a dollar character ('$').

Tokens: {label} - this token can be used to substitute the label of the component at runtime.

Example:
"A value is required for the field '{label}'."