01: /**
02: * EasyBeans
03: * Copyright (C) 2006 Bull S.A.S.
04: * Contact: easybeans@objectweb.org
05: *
06: * This library is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU Lesser General Public
08: * License as published by the Free Software Foundation; either
09: * version 2.1 of the License, or any later version.
10: *
11: * This library is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14: * Lesser General Public License for more details.
15: *
16: * You should have received a copy of the GNU Lesser General Public
17: * License along with this library; if not, write to the Free Software
18: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19: * USA
20: *
21: * --------------------------------------------------------------------------
22: * $Id: EntityContext.java 1100 2006-08-16 13:05:31Z benoitf $
23: * --------------------------------------------------------------------------
24: */package javax.ejb;
25:
26: /**
27: * The EntityContext interface provides an instance with access to the
28: * container-provided runtime context of an entity enterprise Bean instance.
29: * @see <a href="http://www.jcp.org/en/jsr/detail?id=220">EJB 3.0 specification</a>
30: * @author Florent Benoit
31: */
32: public interface EntityContext extends EJBContext {
33:
34: /**
35: * Obtain a reference to the EJB local object that is currently associated
36: * with the instance. An instance of an entity enterprise Bean can call this
37: * method only when the instance is associated with an EJB local object
38: * identity, i.e. in the ejbActivate, ejbPassivate, ejbPostCreate,
39: * ejbRemove, ejbLoad, ejbStore, and business methods. An instance can use
40: * this method, for example, when it wants to pass a reference to itself in
41: * a method argument or result.
42: * @return The EJB local object currently associated with the instance.
43: * @throws IllegalStateException if the instance invokes this method while
44: * the instance is in a state that does not allow the instance to
45: * invoke this method, or if the instance does not have a local
46: * interface.
47: */
48: EJBLocalObject getEJBLocalObject() throws IllegalStateException;
49:
50: /**
51: * Obtain a reference to the EJB object that is currently associated with
52: * the instance. An instance of an entity enterprise Bean can call this
53: * method only when the instance is associated with an EJB object identity,
54: * i.e. in the ejbActivate, ejbPassivate, ejbPostCreate, ejbRemove, ejbLoad,
55: * ejbStore, and business methods. An instance can use this method, for
56: * example, when it wants to pass a reference to itself in a method argument
57: * or result.
58: * @return The EJB object currently associated with the instance.
59: * @throws IllegalStateException Thrown if the instance invokes this method
60: * while the instance is in a state that does not allow the instance
61: * to invoke this method, or if the instance does not have a remote
62: * interface.
63: */
64: EJBObject getEJBObject() throws IllegalStateException;
65:
66: /**
67: * Obtain the primary key of the EJB object that is currently associated
68: * with this instance. An instance of an entity enterprise Bean can call
69: * this method only when the instance is associated with an EJB object
70: * identity, i.e. in the ejbActivate, ejbPassivate, ejbPostCreate,
71: * ejbRemove, ejbLoad, ejbStore, and business methods. Note: The result of
72: * this method is that same as the result of getEJBObject().getPrimaryKey().
73: * @return The primary key currently associated with the instance.
74: * @throws IllegalStateException Thrown if the instance invokes this method
75: * while the instance is in a state that does not allow the instance
76: * to invoke this method.
77: */
78: Object getPrimaryKey() throws IllegalStateException;
79:
80: }
|