org.openmrs.api

Class BlankIdentifierException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.openmrs.api.APIException

org.openmrs.api.PatientIdentifierException

org.openmrs.api.BlankIdentifierException

All Implemented Interfaces:

Serializable

public class BlankIdentifierException
extends PatientIdentifierException

Exception thrown when a Patient or PatientIdentifier is being saved with an empty or null PatientIdentifier.getIdentifier()

See Also:

PatientService, PatientIdentifierException, Serialized Form

Constructor Summary

Constructors

Constructor and Description
BlankIdentifierException() Default empty constructor.
BlankIdentifierException(String message) General constructor to give the end user a helpful message that relates to why this error occurred.
BlankIdentifierException(String message, PatientIdentifier identifier) This is the preferred constructor.
BlankIdentifierException(String message, Throwable cause) Convenience constructor used to simply wrap around a different error cause
BlankIdentifierException(Throwable cause) Constructor used to only wrap around a parent cause.

Method Summary

Methods inherited from class org.openmrs.api.PatientIdentifierException

getPatientIdentifier, setPatientIdentifier

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

Constructor Detail

BlankIdentifierException

public BlankIdentifierException()

Default empty constructor. If at all possible, don't use this one, but use the BlankIdentifierException(String, PatientIdentifier) constructor to specify a helpful message to the end user

BlankIdentifierException

public BlankIdentifierException(String message)

General constructor to give the end user a helpful message that relates to why this error occurred. Preference should be given to BlankIdentifierException(String, PatientIdentifier) over this constructor

Parameters:

message - helpful message string for the end user

BlankIdentifierException

public BlankIdentifierException(String message,
                                PatientIdentifier identifier)

This is the preferred constructor. This gives the end user both a message as to why this error occurred and the identifier which is blank.

Parameters:

message - helpful message string for the end user

identifier - the identifier that is blank

BlankIdentifierException

public BlankIdentifierException(String message,
                                Throwable cause)

Convenience constructor used to simply wrap around a different error cause

Parameters:

message - helpful message string for the end user

cause - parent exception cause that this exception is wrapping around

BlankIdentifierException

public BlankIdentifierException(Throwable cause)

Constructor used to only wrap around a parent cause. Preference should be given to the BlankIdentifierException(String, Throwable) constructor before this one.

Parameters:

cause - the parent wrapping cause