JavaScript Implementation
A JavaScript-based validation rule must implement the relevant interface, depending on whether the rule is used for task-level validation or directory-level validation.
cim1265
A JavaScript-based validation rule must implement the relevant interface, depending on whether the rule is used for task-level validation or directory-level validation.
At validation time,
Identity Manager
calls validate() and passes the value to be validated.This page contains the following topics:
JavaScript Interface for Task-Level Validation
The definition of the JavaScript interface for task-level validation is as follows:
- Syntaxpublic boolean validate( BLTHContext context, String attributeValue, StringRef changedValue, StringRef errorMessage );
- Parameters
- contextInput parameterSpecifies an object that contains methods for retrieving information in the current task session.
- attributeValueInput parameterSpecifies the value of the attribute being validated.
- changedValueOutput parameterProvides an optional transformation value that replaces the user-supplied value being validated. If no transformation is necessary, pass back null.
- errorMessageOutput parameterIf validation fails, it displays a message to the user.The message is displayed through AttributeValidationException. If the method returns false,Identity Managergenerates this exception.
- CommentsThe output parameterschangedValueanderrorMessageare of data type StringRef. StringRef is a predefined data type that contains the fieldreferenceto 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 inattributeValueto be valid, or it passes back a transformed value inchangedValue.
- False. The implementation considersattributeValueto be invalid.Identity Managergenerates an AttributeValidationException that includeserrorMessage.
JavaScript Interface for Directory-Level Validation
The definition of the JavaScript interface for directory-level validation is as follows:
- Syntaxpublic boolean validate( String attributeValue, StringRef changedValue, StringRef errorMessage );
- Parameters
- attributeValueInput parameterSpecifies the value of the attribute being validated.
- changedValueOutput parameterProvides an optional transformation value that replaces the user-supplied value being validated. If no transformation is necessary, pass back null.
- errorMessageOutput parameterIf validation fails, it displays a message to the user.The message is displayed through AttributeValidationException. If the method returns false,Identity Managergenerates this exception.
- CommentsThe output parameterschangedValueanderrorMessageare of data type StringRef. StringRef is a predefined data type that contains the fieldreference,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 inattributeValueto be valid, or it passes back a transformed value inchangedValue.
- False -- the implementation considersattributeValueto be invalid.Identity Managergenerates an AttributeValidationException that includeserrorMessage.