/**
 * The contents of this file are subject to the OpenMRS Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://license.openmrs.org
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific language governing rights and limitations
 * under the License.
 *
 * Copyright (C) OpenMRS, LLC. All Rights Reserved.
 */
package org.openmrs.api;

import org.openmrs.util.OpenmrsConstants;

/**
 * This exception is thrown when a user tries to save or delete a form while forms are locked
 *
 * @see OpenmrsConstants#GLOBAL_PROPERTY_FORMS_LOCKED
 * @see FormService#checkIfFormsAreLocked()
 */
public class FormsLockedException extends APIException {

	private static final long serialVersionUID = 12344321L;

	/**
	 * Generic constructor that gives a normal reason why the user is not being allowed to save or delete a form
	 */
	public FormsLockedException() {
		this("Form.forms.locked");
	}

	/**
	 * Convenience constructor to give the user a message other than normal default one
	 *
	 * @param message the reason to show to the user as to why the forms are locked
	 */
	public FormsLockedException(String message) {
		super(message);
	}

	/**
	 * Convenience constructor to give the user a message other than the normal one and to chain
	 * this exception with a parent exception.
	 *
	 * @param message the reason to show to the user as to why the forms are locked
	 * @param cause the parent exception
	 */
	public FormsLockedException(String message, Throwable cause) {
		super(message, 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
	 * {@link #FormsLockedException(String, Throwable)} constructor is preferred over this one.
	 *
	 * @param cause the parent exception
	 */
	public FormsLockedException(Throwable cause) {
		super(cause);
	}
}