org.openmrs.api

Class EncounterTypeLockedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.openmrs.api.APIException

org.openmrs.api.EncounterTypeLockedException

All Implemented Interfaces:

Serializable

public class EncounterTypeLockedException
extends APIException

This exception is thrown when a encounter types are locked and the user tries to edit an encounter type type, this is done by a global property being true/false.

Since:

1.10 added to 1.8.5 and 1.9.4

See Also:

OpenmrsConstants.GLOBAL_PROPERTY_ENCOUNTER_TYPES_LOCKED, EncounterService#checkIfLocked(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
EncounterTypeLockedException() Generic constructor that gives a normal message about editing not being allowed to the user.
EncounterTypeLockedException(String message) Convenience constructor to give the user a message other than normal default one
EncounterTypeLockedException(String message, Throwable cause) Convenience constructor to give the user a message other than the normal one and to chain this exception with a parent exception.
EncounterTypeLockedException(Throwable cause) Convenience constructor used to only set the parent exception to chain with.

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

Constructor Detail

EncounterTypeLockedException

public EncounterTypeLockedException()

Generic constructor that gives a normal message about editing not being allowed to the user.

EncounterTypeLockedException

public EncounterTypeLockedException(String message)

Convenience constructor to give the user a message other than normal default one

Parameters:

message - the String to show to the user as to why the encounter types are locked

EncounterTypeLockedException

public EncounterTypeLockedException(String message,
                                    Throwable cause)

Convenience constructor to give the user a message other than the normal one and to chain this exception with a parent exception.

Parameters:

message - the String to show to the user as to why the encounter types are locked

cause - the parent exception

EncounterTypeLockedException

public EncounterTypeLockedException(Throwable cause)

Convenience constructor used to only set the parent exception to chain with. This does not set the error message for the user as to why an exception is being thrown. The EncounterTypeLockedException(String, Throwable) constructor is preferred over this one.

Parameters:

cause - the parent exception