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: EJBLocalObject.java 1100 2006-08-16 13:05:31Z benoitf $
23: * --------------------------------------------------------------------------
24: */package javax.ejb;
25:
26: /**
27: * Used by EJB 2.1 for their business local interface.
28: * @see <a href="http://www.jcp.org/en/jsr/detail?id=220">EJB 3.0 specification</a>
29: * @author Florent Benoit
30: */
31: public interface EJBLocalObject {
32:
33: /**
34: * Obtain the enterprise Bean's local home interface. The local home
35: * interface defines the enterprise Bean's create, finder, remove, and home
36: * business methods that are available to local clients.
37: * @return A reference to the enterprise Bean's local home interface.
38: * @throws EJBException Thrown when the method failed due to a system-level
39: * failure.
40: */
41: EJBLocalHome getEJBLocalHome() throws EJBException;
42:
43: /**
44: * Obtain the primary key of the EJB local object.<br>
45: * This method can be called on an entity bean. An attempt to invoke this
46: * method on a session Bean will result in an EJBException.
47: * @return The EJB local object's primary key.
48: * @throws EJBException Thrown when the method failed due to a system-level
49: * failure or when invoked on a session bean.
50: */
51: Object getPrimaryKey() throws EJBException;
52:
53: /**
54: * Remove the EJB local object.
55: * @throws RemoveException The enterprise Bean or the container does not
56: * allow destruction of the object.
57: * @throws EJBException Thrown when the method failed due to a system-level
58: * failure.
59: */
60: void remove() throws RemoveException, EJBException;
61:
62: /**
63: * Test if a given EJB local object is identical to the invoked EJB local
64: * object.
65: * @param obj An object to test for identity with the invoked object.
66: * @return True if the given EJB local object is identical to the invoked
67: * object, false otherwise.
68: * @throws EJBException Thrown when the method failed due to a system-level
69: * failure.
70: */
71: boolean isIdentical(EJBLocalObject obj) throws EJBException;
72:
73: }
|