01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package javax.ejb;
23:
24: import java.rmi.RemoteException;
25:
26: /**
27: * <P>The EJBHome interface must be extended by all enterprise Beans' remote home interfaces.
28: * An enterprise Bean's remote home interface defines the methods that allow a remote client to
29: * create, find, and remove EJB objects, as well as home business methods that are not specific to
30: * a bean instance (Session Beans do not have finders and home methods).</P>
31: *
32: * <P>The remote home interface is defined by the enterprise Bean provider and implemented by the
33: * enterprise Bean container.</P>
34: */
35: public interface EJBHome extends java.rmi.Remote {
36:
37: /**
38: * Remove an EJB object identified by its handle.
39: *
40: * @exception java.rmi.RemoteException - Thrown when the method failed due to a system-level failure.
41: * @exception RemoveException - Thrown if the enterprise Bean or the container does not allow
42: * the client to remove the object.
43: */
44: public void remove(Handle handle) throws RemoteException,
45: RemoveException;
46:
47: /**
48: * <P>Remove an EJB object identified by its primary key.</P>
49: *
50: * <P>This method can be used only for an entity bean. An attempt to call this method on
51: * a session bean will result in a RemoteException.</P>
52: *
53: * @exception java.rmi.RemoteException - Thrown when the method failed due to a system-level failure.
54: * @exception RemoveException - Thrown if the enterprise Bean or the container does not allow
55: * the client to remove the object.
56: */
57: public void remove(Object primaryKey) throws RemoteException,
58: RemoveException;
59:
60: /**
61: * <P>Obtain the EJBMetaData interface for the enterprise Bean. The EJBMetaData interface allows
62: * the client to obtain information about the enterprise Bean.</P>
63: *
64: * <P>The information obtainable via the EJBMetaData interface is intended to be used by tools.</P>
65: *
66: * @return The enterprise Bean's EJBMetaData interface.
67: * @exception java.rmi.RemoteException - Thrown when the method failed due to a system-level failure.
68: */
69: public EJBMetaData getEJBMetaData() throws RemoteException;
70:
71: /**
72: * Obtain a handle for the remote home object. The handle can be used at later time to re-obtain
73: * a reference to the remote home object, possibly in a different Java Virtual Machine.
74: *
75: * @return A handle for the remote home object.
76: * @exception java.rmi.RemoteException - Thrown when the method failed due to a system-level failure.
77: */
78: public HomeHandle getHomeHandle() throws RemoteException;
79:
80: }
|