org.openmrs.api

Class FormsLockedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.openmrs.api.APIException

org.openmrs.api.FormsLockedException

All Implemented Interfaces:

Serializable

public class FormsLockedException
extends APIException

This exception is thrown when a user tries to save or delete a form while forms are locked

See Also:

OpenmrsConstants.GLOBAL_PROPERTY_FORMS_LOCKED, FormService.checkIfFormsAreLocked(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
FormsLockedException() Generic constructor that gives a normal reason why the user is not being allowed to save or delete a form
FormsLockedException(String message) Convenience constructor to give the user a message other than normal default one
FormsLockedException(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.
FormsLockedException(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

FormsLockedException

public FormsLockedException()

Generic constructor that gives a normal reason why the user is not being allowed to save or delete a form

FormsLockedException

public FormsLockedException(String message)

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

Parameters:

message - the reason to show to the user as to why we cannot save or delete the form

FormsLockedException

public FormsLockedException(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 reason to show to the user as to why we cannot save or delete the form

cause - the parent exception

FormsLockedException

public FormsLockedException(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 FormsLockedException(String, Throwable) constructor is preferred over this one.

Parameters:

cause - the parent exception