KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > ejb > EntityCache


1 /*
2 * JBoss, Home of Professional Open Source
3 * Copyright 2005, JBoss Inc., and individual contributors as indicated
4 * by the @authors tag. See the copyright.txt in the distribution for a
5 * full listing of individual contributors.
6 *
7 * This is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU Lesser General Public License as
9 * published by the Free Software Foundation; either version 2.1 of
10 * the License, or (at your option) any later version.
11 *
12 * This software is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this software; if not, write to the Free
19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21 */

22 package org.jboss.ejb;
23
24 /**
25  * EntityCaches can work from several keys.
26  *
27  * <p>A cache can use the natural primaryKey from the EJBObject, or DB
28  * dependent keys or a proprietary key
29  *
30  * @see EntityInstanceCache
31  *
32  * @author <a HREF="mailto:marc.fleury@telkel.com">Marc Fleury</a>
33  * @version $Revision: 37459 $
34  */

35 public interface EntityCache
36    extends InstanceCache
37 {
38    /**
39     * Returns the key used to cache the context
40     *
41     * @param id Object id / primary key
42     * @return Cache key
43     */

44    Object JavaDoc createCacheKey(Object JavaDoc id);
45 }
46
Popular Tags