KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > ejb > EJBHome


1 /**
2  * EasyBeans
3  * Copyright (C) 2006 Bull S.A.S.
4  * Contact: easybeans@objectweb.org
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * 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: EJBHome.java 1100 2006-08-16 13:05:31Z benoitf $
23  * --------------------------------------------------------------------------
24  */

25
26 package javax.ejb;
27
28 import java.rmi.Remote JavaDoc;
29 import java.rmi.RemoteException JavaDoc;
30
31 /**
32  * Used by EJB 2.1 for their business remote home interface.
33  * @see <a HREF="http://www.jcp.org/en/jsr/detail?id=220">EJB 3.0 specification</a>
34  * @author Florent Benoit
35  */

36 public interface EJBHome extends Remote JavaDoc {
37
38     /**
39      * Remove an EJB object identified by its handle.
40      * @param handle the given handle
41      * @throws RemoteException Thrown when the method failed due to a
42      * system-level failure.
43      * @throws RemoveException Thrown if the enterprise Bean or the container
44      * does not allow the client to remove the object.
45      */

46     void remove(Handle JavaDoc handle) throws RemoteException JavaDoc, RemoveException JavaDoc;
47
48     /**
49      * Remove an EJB object identified by its primary key.
50      * @param primaryKey the given primary key;
51      * @throws RemoteException Thrown when the method failed due to a
52      * system-level failure.
53      * @throws RemoveException Thrown if the enterprise Bean or the container
54      * does not allow the client to remove the object.
55      */

56     void remove(Object JavaDoc primaryKey) throws RemoteException JavaDoc, RemoveException JavaDoc;
57
58     /**
59      * Obtain the EJBMetaData interface for the enterprise Bean. The EJBMetaData
60      * interface allows the client to obtain information about the enterprise
61      * Bean.<br>
62      * The information obtainable via the EJBMetaData interface is intended to
63      * be used by tools.
64      * @return The enterprise Bean's EJBMetaData interface.
65      * @throws RemoteException Thrown when the method failed due to a
66      * system-level failure.
67      */

68     EJBMetaData JavaDoc getEJBMetaData() throws RemoteException JavaDoc;
69
70     /**
71      * Obtain a handle for the remote home object. The handle can be used at
72      * later time to re-obtain a reference to the remote home object, possibly
73      * in a different Java Virtual Machine.
74      * @return A handle for the remote home object.
75      * @throws RemoteException Thrown when the method failed due to a
76      * system-level failure.
77      */

78     HomeHandle JavaDoc getHomeHandle() throws RemoteException JavaDoc;
79
80 }
81
Popular Tags