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 EJBLocalHome interface must be extended by all enterprise
41 * Beans' local home interfaces. An enterprise Bean's local home
42 * interface defines the methods that allow local clients to create,
43 * find, and remove EJB objects, as well as home business methods that
44 * are not specific to a bean instance (session Beans do not have
45 * finders and home business methods).
46 *
47 * <p> The local home interface is defined by the enterprise Bean provider
48 * and implemented by the enterprise Bean container.
49 */
50 public interface EJBLocalHome {
51
52 /**
53 * Remove an EJB object identified by its primary key.
54 *
55 * <p>This method can only be used by local clients of an entity bean.
56 * An attempt
57 * to call this method on a session bean will result in a RemoveException.
58 *
59 * @exception RemoveException Thrown if the enterprise Bean or
60 * the container does not allow the client to remove the object.
61 *
62 * @exception EJBException Thrown when the method failed due to a
63 * system-level failure.
64 *
65 */
66 void remove(Object primaryKey) throws RemoveException, EJBException;
67
68 }
69
Save This Page