Oracle Apex Item setValidity() - JavaScript

Oracle Apex provides a powerful set of JavaScript APIs that allows developers to create dynamic and responsive web applications. One of the most useful APIs is the setValidity() method that helps in validating the data entered by the user in various input fields.

What is setValidity() method?

The setValidity() method is a JavaScript function used to validate the data entered by the user in an HTML input field. This method is used to set the validity of the input field and display validation error messages if the entered data is not valid.

The setValidity() method takes two parameters:

1. Validity - A boolean value - true or false - indicating whether the input field is valid or not.
2. Validation Message - A string that contains the error message to be displayed if the input field is invalid.

Syntax of setValidity() method

item.setValidity(validity, validationMessage);

Where:

item: It represents the input field that needs to be validated.

validity: It is a boolean value that indicates whether the input field is valid or not.

validationMessage: It is a string that contains the error message to be displayed if the input field is invalid.

Examples of setValidity() method

Example 1: Validating a number input field

Let's say you have an input field with an id P1_NUMBER that should only allow numeric values. The following code will validate the entered value and display the error message if the entered value is not a number.

var number = apex.item('P1_NUMBER').getValue();
var isValid = !isNaN(number);

apex.item('P1_NUMBER').setValidity(isValid, 'Please enter a valid number');

Example 2: Validating a date input field

In this example, let's say you have an input field with an id P1_DATE that should only allow date values in the format 'YYYY/MM/DD'. The following code will validate the entered date and display the error message if the entered date is not in the correct format.

var date = apex.item('P1_DATE').getValue();
var isValid = /^\d{4}\/\d{2}\/\d{2}$/.test(date);

apex.item('P1_DATE').setValidity(isValid, 'Please enter a valid date in the format YYYY/MM/DD');

Conclusion

The setValidity() method is a simple yet powerful feature provided by Oracle Apex to validate user input fields. It helps in improving the user experience by displaying relevant error messages and preventing incorrect data from being submitted.