1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36
37 package javax.ejb;
38
39 /**
40 * The EJBLocalObject interface must be extended by all enterprise Beans' local
41 * interfaces. An enterprise Bean's local interface provides the local client
42 * view of an EJB object. An enterprise Bean's local interface defines
43 * the business methods callable by local clients.
44 *
45 * <p> The enterprise Bean's local interface is defined by the enterprise
46 * Bean provider and implemented by the enterprise Bean container.
47 */
48 public interface EJBLocalObject {
49 /**
50 * Obtain the enterprise Bean's local home interface. The local home
51 * interface defines the enterprise Bean's create, finder, remove,
52 * and home business methods that are available to local clients.
53 *
54 * @return A reference to the enterprise Bean's local home interface.
55 *
56 * @exception EJBException Thrown when the method failed due to a
57 * system-level failure.
58 *
59 */
60 public EJBLocalHome getEJBLocalHome() throws EJBException;
61
62 /**
63 * Obtain the primary key of the EJB local object.
64 *
65 * <p> This method can be called on an entity bean.
66 * An attempt to invoke this method on a session Bean will result in
67 * an EJBException.
68 *
69 * @return The EJB local object's primary key.
70 *
71 * @exception EJBException Thrown when the method failed due to a
72 * system-level failure or when invoked on a session bean.
73 *
74 */
75 public Object getPrimaryKey() throws EJBException;
76
77 /**
78 * Remove the EJB local object.
79 *
80 * @exception RemoveException The enterprise Bean or the container
81 * does not allow destruction of the object.
82 *
83 * @exception EJBException Thrown when the method failed due to a
84 * system-level failure.
85 *
86 */
87 public void remove() throws RemoveException, EJBException;
88
89 /**
90 * Test if a given EJB local object is identical to the invoked EJB
91 * local object.
92 *
93 * @param obj An object to test for identity with the invoked object.
94 *
95 * @return True if the given EJB local object is identical to the
96 * invoked object, false otherwise.
97 *
98 *
99 * @exception EJBException Thrown when the method failed due to a
100 * system-level failure.
101 *
102 */
103 boolean isIdentical(EJBLocalObject obj) throws EJBException;
104 }
Save This Page