/*
 * 14/06/2004 - 23:12:27
 *
 * $RCSfile: CacheIdManager.java,v $ - JDBF Object Relational mapping system
 * Copyright (C) 2002-2004 JDBF Development Team
 * 
 * http://jdbf.sourceforge.net
 *
 * 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 2
 * 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/*
 * 
 * $Id: CacheIdManager.java,v 1.1 2004/06/28 22:08:46 gmartone Exp $
 */
package org.jdbf.engine.caching;


import org.jdbf.engine.basic.ObjectMapped;
import org.jdbf.engine.basic.PrimaryKey;
import org.jdbf.engine.mapping.PrimaryKeyMap;

/**
 * <code>CacheIdManager</code> handles the creation of cache id for object.<br>
 * Cache id value is created appending all value fo al primary key for this object.
 * 
 *  
 * @author Giovanni Martone<br>
 * @version $Revision: 1.1 $<br>
 * last changed by $Author: gmartone $
 */
public interface CacheIdManager {

	/**
	 * 
	 * Creates id cache for an object specified in obj.
	 * 
	 * Value of cache id is created on value of primary key.
	 *
	 * @param pk PrimaryKeyMap
	 * @param object ObjectMapped
	 * @return String cache id
	 * @throws CacheException
	 *  
	 */
    public String createCacheId(PrimaryKeyMap pk, 
    							ObjectMapped object) throws CacheException;
    							

	/**
	 * 
	 * Creates id cache for an object.
	 * 
	 * Value of cache id is created on value of primary key
	 * specified in pk parameter.
	 *
	 * @param pk PrimaryKey
	 * @param pkm PrimaryKeyMap
	 * @return String cache id
	 * @throws CacheException
	 *  
	 */
	public String createCacheId(PrimaryKey pk,PrimaryKeyMap pkm) 
		throws CacheException;
    							
}

/*
 * 
 * $Log: CacheIdManager.java,v $
 * Revision 1.1  2004/06/28 22:08:46  gmartone
 * Initial revision (task 80421 Enanchement DCS)
 *
 * 
 */