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

JavaScript Interface for Directory-Level Validation

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

• Syntax

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

• Parameters
  • 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 Identity Manager 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 Identity Manager generates an AttributeValidationException that includes errorMessage.