xdev.db.locking.LockNotificationStrategy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xapi Show documentation
XDEV Application Framework
There is a newer version: 6.0.2
package xdev.db.locking;

/*-
 * #%L
 * XDEV Application Framework
 * %%
 * Copyright (C) 2003 - 2020 XDEV Software
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */


import xdev.ui.locking.Lockable;


/**
 * Defines how the user should be informed about a specific lock state. For
 * example already locked records.
 * 
 * @author XDEV Software jwill
 * @since 4.0
 */
public interface LockNotificationStrategy
{
	/**
	 * Triggers the notification process for a specific lock state.
	 * 
	 * @param inUseException
	 *            the specific lock in use information.
	 * @param lock
	 *            the concerned lock
	 * @param lockable
	 *            the lockable which contains the notification monitor -
	 *            {@link Lockable#getLockInUseNotifier()}
	 * @throws LockingException
	 *             if the locking process fails.
	 */
	void lockInUseNotification(RowAlreadyLockedException inUseException, PessimisticLock lock,
			Lockable lockable) throws LockingException;
	
	
	/**
	 * Triggers the notification process for a specific lock state.
	 * 
	 * @param cause
	 *            the specific locking error information.
	 * @param lock
	 *            the concerned lock
	 * @param lockable
	 *            the lockable which contains the notification monitor -
	 *            {@link Lockable#getLockInUseNotifier()}
	 * @throws LockingException
	 *             if the locking process fails.
	 */
	void lockInUseNotification(LockingException cause, PessimisticLock lock, Lockable lockable)
			throws LockingException;
	
	
	/**
	 * Triggers the notification process for a specific lock state.
	 * 
	 * @param lock
	 *            the concerned lock
	 * @param lockable
	 *            the lockable which contains the notification monitor -
	 *            {@link Lockable#getLockInUseNotifier()}
	 * @throws LockingException
	 *             if the locking process fails.
	 */
	void lockInUseNotification(PessimisticLock lock, Lockable lockable) throws LockingException;
	
	
	/**
	 * Releases the notification process after a specific lock state.
	 * 
	 * @param lock
	 *            the concerned {@link PessimisticLock} instance.
	 * @param lockable
	 *            the lockable which contains the notification monitor -
	 *            {@link Lockable#getLockInUseNotifier()}
	 */
	void lockInUseNotificationFinished(PessimisticLock lock, Lockable lockable);
}