org.openmrs.api

Class APIException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.openmrs.api.APIException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

APIAuthenticationException, CannotDeleteRoleWithChildrenException, ConceptInUseException, ConceptNameInUseException, ConceptsLockedException, ConceptStopWordException, ContextAuthenticationException, CustomDatatypeException, DAOException, DuplicateConceptNameException, EncounterTypeLockedException, FormsLockedException, ImmutableResultException, InvalidActivationKeyException, InvalidCustomValueException, InvalidFileTypeException, InvalidOperationOnObjectException, MissingRequiredPropertyException, NotYetPersistedException, OrderEntryException, PasswordException, PatientIdentifierException, PatientIdentifierTypeLockedException, PersonAttributeTypeLockedException, ProgramNameDuplicatedException, ProposingConceptException, ServiceNotFoundException, UnallowedIdentifierException, UnchangeablePropertyException, ValidationException

public class APIException
extends RuntimeException

Represents often fatal errors that occur within the API infrastructure. All service methods should be marked as possibly throwing this exception. The preferred methods to use in this exception is the APIException(String, Throwable) or the APIException(String)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
APIException() Default empty constructor.
APIException(String message) General constructor to give the end user a helpful message that relates to why this error occurred.
APIException(String messageKey, Object[] parameters) Constructor to give the end user a helpful message that relates to why this error occurred.
APIException(String messageKey, Object[] parameters, Throwable cause) Constructor to give the end user a helpful message and to also propagate the parent error exception message..
APIException(String message, Throwable cause) General constructor to give the end user a helpful message and to also propagate the parent error exception message.
APIException(Throwable cause) Constructor used to simply chain a parent exception cause to an APIException.

Method Summary

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

APIException

public APIException()

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

APIException

public APIException(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

APIException

public APIException(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 APIException is wrapping around

APIException

public APIException(Throwable cause)

Constructor used to simply chain a parent exception cause to an APIException. Preference should be given to the APIException(String, Throwable) constructor if at all possible instead of this one.

Parameters:

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

APIException

public APIException(String messageKey,
                    Object[] parameters)

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

Parameters:

messageKey - message code to retrieve

parameters - message parameters

APIException

public APIException(String messageKey,
                    Object[] parameters,
                    Throwable cause)

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

Parameters:

messageKey - message code to retrieve

parameters - message parameters

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