01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * 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: 57209 $
34: */
35: public interface EntityCache extends InstanceCache {
36: /**
37: * Returns the key used to cache the context
38: *
39: * @param id Object id / primary key
40: * @return Cache key
41: */
42: Object createCacheKey(Object id);
43: }
|