org.openmrs.validator

Class ValidateUtil

java.lang.Object

org.openmrs.validator.ValidateUtil

public class ValidateUtil
extends Object

This class should be used in the *Services to validate objects before saving them.

The validators are added to this class in the spring applicationContext-service.xml file.

Example usage:

  public Order saveOrder(order) {
        ValidateUtil.validate(order);
        dao.saveOrder(order);
  }
 

Since:

1.5

Method Summary

Modifier and Type	Method and Description
static void	disableValidationForThread() Used to indicate that validation should be disabled for the current thread NOTE: This should always be used in conjunction with the resumeValidationForThread method
static Boolean	getDisableValidation()
static boolean	isValidationDisabledForThread()
static void	resumeValidationForThread() Used to indicate that validation should be re-enabled for the current thread Typically this would be placed in a `finally` block after the disableValidationForThread method is used
static void	setDisableValidation(Boolean disableValidation)
static void	validate(Object obj) Test the given object against all validators that are registered as compatible with the object class
static void	validate(Object obj, org.springframework.validation.Errors errors) Test the given object against all validators that are registered as compatible with the object class
static void	validateFieldLengths(org.springframework.validation.Errors errors, Class<?> aClass, String... fields) Test the field lengths are valid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

validate

public static void validate(Object obj)
                     throws ValidationException

Test the given object against all validators that are registered as compatible with the object class

Parameters:

obj - the object to validate

Throws:

ValidationException - thrown if a binding exception occurs Should throw APIException if errors occur during validation Should return immediately if validation is disabled

validate

public static void validate(Object obj,
                            org.springframework.validation.Errors errors)

Test the given object against all validators that are registered as compatible with the object class

Parameters:

obj - the object to validate

errors - the validation errors found

Since:

1.9 Should populate errors if object invalid Should return immediately if validation is disabled and have no errors

validateFieldLengths

public static void validateFieldLengths(org.springframework.validation.Errors errors,
                                        Class<?> aClass,
                                        String... fields)

Test the field lengths are valid

Parameters:

errors -

aClass - the class of the object being tested

fields - a var args that contains all of the fields from the model Should pass validation if regEx field length is not too long Should fail validation if regEx field length is too long Should fail validation if name field length is too long Should return immediately if validation is disabled and have no errors

getDisableValidation

public static Boolean getDisableValidation()

setDisableValidation

public static void setDisableValidation(Boolean disableValidation)

isValidationDisabledForThread

public static boolean isValidationDisabledForThread()

Returns:

true if validation has been disabled for the current thread, false otherwise

Since:

2.5.8

disableValidationForThread

public static void disableValidationForThread()

Used to indicate that validation should be disabled for the current thread NOTE: This should always be used in conjunction with the resumeValidationForThread method

Since:

2.5.8

resumeValidationForThread

public static void resumeValidationForThread()

Used to indicate that validation should be re-enabled for the current thread Typically this would be placed in a `finally` block after the disableValidationForThread method is used

Since:

2.5.8