ISession.java

/**
 * Copyright (C) 2008-2010, Squale Project - http://www.squale.org
 *
 * This file is part of Squale.
 *
 * Squale 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 any later version.
 *
 * Squale 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 Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Squale.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.squale.jraf.spi.persistence;

import org.squale.jraf.commons.exception.JrafPersistenceException;

/**
 * <p>Project: JRAF 
 * <p>Module: jrafSpi
 * <p>Title : ISession.java</p>
 * <p>Description : </p>
 * <p>Copyright : Copyright (c) 2004</p>
 *  
 */
/**
 * Cette interface d�finie l'unit� de travail dans laquelle sont effectu�s tous les
 * traitement dans les DAOs.
 * @author Courtial Gilles
 */
public interface ISession {

	/**
	 * D�marrage d'une transaction utilisation d'une transaction
	 * dans le cadre d'une gestion transactionnelle manag�e par container (CMT) 
	 * @throws JrafPersistenceException
	 */
	void beginTransaction() throws JrafPersistenceException;

	/**
	 * Execution des requ�tes HQL en attentes et validation des traitements
	 * en base de donn�es. Utilisation de la transaction sous jacente.
	 * La session associ�e est ferm�e.
	 * @throws JrafPersistenceException
	 */
	void commitTransaction() throws JrafPersistenceException;

	/**
	 * Annulation des ordres passes pendant la transaction
	 */
	void rollbackTransaction();

	/**
	 * Execution des requ�tes HQL en attentes et validation des traitements
	 * en base de donn�es. Utilisation de la transaction sous jacente.
	 * La session associee n'est pas fermee et reste utilisable.
	 * @throws JrafPersistenceException
	 */
	void commitTransactionWithoutClose() throws JrafPersistenceException;

	/**
	 * Annulation des ordres passes pendant la transaction.
	 * La session associee n'est pas fermee et reste utilisable.
	 */
	void rollbackTransactionWithoutClose();

	/**
	 * Fermeture de la session
	 * @throws JrafPersistenceException
	 */
	public void closeSession() throws JrafPersistenceException;

	/**
	 * Suppression de l'objet du cache session
	 * @param object
	 * @throws JrafPersistenceException
	 */
	void evict(Object object) throws JrafPersistenceException;

	/**
	 * Supprimer l'ensemble des objets du cache session
	 */
	void clear();

	/**
	 * retourne true si l'objet existe dans le cache ou comme proxy
	 * retourne false sinon 
	 * @param object
	 * @return
	 */
	public boolean contains(Object object);
	
	
	/**
	 * Retourne true si la session est toujours ouverte, false sinon.
	 * @return true si la session est toujours ouverte, false sinon.
	 */
	public boolean isOpen();
	
	public void invalidate();
	public boolean isValid();
}