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: /**
25: * <p>The EJBLocalHome interface must be extended by all enterprise Beans'
26: * local home interfaces. An enterprise Bean's local home interface defines
27: * the methods that allow local clients to create, find, and remove EJB
28: * objects, as well as home business methods that are not specific to a
29: * bean instance (session Beans do not have finders and home business methods).</p>
30: *
31: * <p>The local home interface is defined by the enterprise Bean provider
32: * and implemented by the enterprise Bean container.</p>
33: */
34: public interface EJBLocalHome {
35:
36: /**
37: * <p>Remove an EJB object identified by its primary key.</p>
38: *
39: * <p>This method can only be used by local clients of an entity bean.
40: * An attempt to call this method on a session bean will result in an EJBException.</p>
41: *
42: * @param primaryKey - The primary key
43: * @exception RemoveException - Thrown if the enterprise Bean or the container does
44: * not allow the client to remove the object.
45: * @exception EJBException - Thrown when the method failed due to a system-level failure.
46: */
47: public void remove(java.lang.Object primaryKey)
48: throws RemoveException, EJBException;
49: }
|