org.openmrs.api

Class ValidationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.openmrs.api.APIException

org.openmrs.api.ValidationException

All Implemented Interfaces:

Serializable

public class ValidationException
extends APIException

Represents often fatal errors that occur when an object fails validation

Since:

1.10

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ValidationException() Default empty constructor.
ValidationException(org.springframework.validation.Errors errors) Constructor used to associate an Spring Errors object with a ValidationException
ValidationException(String message) General constructor to give the end user a helpful message that relates to why this error occurred.
ValidationException(String message, org.springframework.validation.Errors errors) Constructor to give the end user a helpful message and to associate an Spring Errors object with a ValidationException
ValidationException(String message, Throwable cause) General constructor to give the end user a helpful message and to also propagate the parent error exception message.
ValidationException(Throwable cause) Constructor used to simply chain a parent exception cause to an ValidationException.

Method Summary

Modifier and Type	Method and Description
org.springframework.validation.Errors	getErrors()
void	setErrors(org.springframework.validation.Errors errors)

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ValidationException

public ValidationException()

Default empty constructor. If at all possible, don't use this one, but use the

ValidationException

public ValidationException(String message)

General constructor to give the end user a helpful message that relates to why this error occurred.

Parameters:

message - helpful message string for the end user

ValidationException

public ValidationException(String message,
                           Throwable cause)

General constructor to give the end user a helpful message and to also propagate the parent error exception message.

Parameters:

message - helpful message string for the end user

cause - the parent exception cause that this ValidationException is wrapping around

ValidationException

public ValidationException(Throwable cause)

Constructor used to simply chain a parent exception cause to an ValidationException.

Parameters:

cause - the parent exception cause that this ValidationException is wrapping around

ValidationException

public ValidationException(org.springframework.validation.Errors errors)

Constructor used to associate an Spring Errors object with a ValidationException

Parameters:

errors -

Since:

1.11

ValidationException

public ValidationException(String message,
                           org.springframework.validation.Errors errors)

Constructor to give the end user a helpful message and to associate an Spring Errors object with a ValidationException

Parameters:

errors -

Since:

1.11

Method Detail

getErrors

public org.springframework.validation.Errors getErrors()

Since:

1.11

setErrors

public void setErrors(org.springframework.validation.Errors errors)

Since:

1.11