oracle.adf.view.faces.validator
Interface ClientValidator

public interface ClientValidator

Interface implemented by Objects that wish to perform client-side validation in addition to server-side validation. Client side validation should always be the same or or more lenient than the server-side validation.

One of the benefits of ADF Faces is that it supports client-side versions of converters and validators. This means that errors can be caught on the client and a round trip avoided. This class can be used to add client-side validation to a validator.

The basic idea of ADF Faces client-side validation is that it works on the client in a very similar way to how it works on the server, except the language on the client is javascript instead of java. ADF Faces supports javascript Validator objects that support the method validate(). A Validator can throw a ValidatorException.

Let's say you've written a javax.faces.validator.Validator implementation and now you want to add client-side validation. The first thing to do is write a version of the validator in javascript. Here is the javascript code for the validator "interface".

 /**
  * Validator "interface" similar to javax.faces.validator.Validator,
  * except that all relevant information must be passed to the constructor
  * as the context and component are not passed to the validate method 
  * /
 function Validator(){}
 
 /**
 * Perform the correctness checks implemented by this Validator. 
 * If any violations are found, a ValidatorException will be thrown.
 * /
 Validator.prototype.validate = function(value){}
 
 

Validators can throw a ValidatorException, here is the signature:

• ValidatorException(detail)
  • detail - Localized detail message text

The javascript validator is attached using this interface, ClientValidator. The method getClientScript() is expected to return an implementation of the javascript Validator object. The method getClientValidation() is expected to return a javascript constructor which will be used to instantiate an instance of the validator.

See Also:

Validator

Method Summary

java.lang.String	getClientScript(FacesContext context, UIComponent component) Opportunity for the ClientValidator to return script content.
java.lang.String	getClientValidation(FacesContext context, UIComponent component) Called to retrieve the appropriate client validation code for the node and context.

Method Detail

getClientScript

public java.lang.String getClientScript(FacesContext context,
                                        UIComponent component)

Opportunity for the ClientValidator to return script content. For HTML, this will be javascript that will be embedded in a script tag. For HTML this method is expected to return an implementation of the javascript Validator object.

This method will be called once per validator instance. Content that should only be written once per request should only be returned once.

getClientValidation

public java.lang.String getClientValidation(FacesContext context,
                                            UIComponent component)

Called to retrieve the appropriate client validation code for the node and context. For HTML, this will be javascript that will be embedded in a script tag. For HTML this method is expected to return a constructor of the javascript Validator object returned by getClientScript().