User Console Design Guide › Validation Rules › How to Implement Custom Validation Rules › JavaScript Implementation › JavaScript Interface for Task-Level Validation

JavaScript Interface for Task-Level Validation

The definition of the JavaScript interface for task-level validation is as follows:

Syntax

public boolean validate(
   BLTHContext context,
   String attributeValue,
   StringRef changedValue,
   StringRef errorMessage
   );

Parameters

context

Input parameter

Specifies an object that contains methods for retrieving information in the current task session.

attributeValue

Input parameter

Specifies the value of the attribute being validated.

changedValue

Output parameter

Provides an optional transformation value that replaces the user-supplied value being validated. If no transformation is necessary, pass back null.

errorMessage

Output parameter

If validation fails, it displays a message to the user.

The message is displayed through AttributeValidationException. If the method returns false, CA IdentityMinder generates this exception.

Comments

The output parameters changedValue and errorMessage are of data type StringRef. StringRef is a predefined data type that contains the field reference to which you assign a value, as shown in the following examples:

• Add a 1 prefix for a properly formatted telephone number:

  changedValue.reference="+1 " + phoneNumber;
  

• Provide an error message for an improperly formatted number:

  errorMessage.reference="Phone number " + phoneNumber + 
              " does not match the format nnn-nnn-nnnn.";
  

Returns

• True. The implementation considers the value in attributeValue to be valid, or it passes back a transformed value in changedValue.
• False. The implementation considers attributeValue to be invalid. CA IdentityMinder generates an AttributeValidationException that includes errorMessage.