001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036: package javax.ejb;
037:
038: import java.rmi.RemoteException;
039:
040: /**
041: * The EJBHome interface must be extended by all enterprise
042: * Beans' remote home interfaces. An enterprise Bean's remote home interface
043: * defines the
044: * methods that allow a remote client to create, find, and remove EJB objects,
045: * as well as home business methods that
046: * are not specific to a bean instance (Session Beans do not have
047: * finders and home methods).
048:
049: * <p> The remote home interface is defined by the enterprise Bean provider and
050: * implemented by the enterprise Bean container.
051: */
052: public interface EJBHome extends java.rmi.Remote {
053:
054: /**
055: * Remove an EJB object identified by its handle.
056: *
057: * @exception RemoveException Thrown if the enterprise Bean or
058: * the container does not allow the client to remove the object.
059: *
060: * @exception RemoteException Thrown when the method failed due to a
061: * system-level failure.
062: */
063: void remove(Handle handle) throws RemoteException, RemoveException;
064:
065: /**
066: * Remove an EJB object identified by its primary key.
067: *
068: * <p>This method can be used only for an entity bean. An attempt
069: * to call this method on a session bean will result in a RemoveException.
070: *
071: * @exception RemoveException Thrown if the enterprise Bean or
072: * the container does not allow the client to remove the object.
073: *
074: * @exception RemoteException Thrown when the method failed due to a
075: * system-level failure.
076: */
077: void remove(Object primaryKey) throws RemoteException,
078: RemoveException;
079:
080: /**
081: * Obtain the EJBMetaData interface for the enterprise Bean. The
082: * EJBMetaData interface allows the client to obtain information about
083: * the enterprise Bean.
084: *
085: * <p> The information obtainable via the EJBMetaData interface is
086: * intended to be used by tools.
087: *
088: * @return The enterprise Bean's EJBMetaData interface.
089: *
090: * @exception RemoteException Thrown when the method failed due to a
091: * system-level failure.
092: */
093: EJBMetaData getEJBMetaData() throws RemoteException;
094:
095: /**
096: * Obtain a handle for the remote home object. The handle can be used at
097: * later time to re-obtain a reference to the remote home object, possibly
098: * in a different Java Virtual Machine.
099: *
100: * @return A handle for the remote home object.
101: *
102: * @exception RemoteException Thrown when the method failed due to a
103: * system-level failure.
104: */
105: HomeHandle getHomeHandle() throws RemoteException;
106: }
|