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 EJBObject interface is extended by all enterprise Beans' remote
042: * interfaces. An enterprise Bean's remote interface provides the remote
043: * client view
044: * of an EJB object. An enterprise Bean's remote interface defines
045: * the business methods callable by a remote client.
046: *
047: * <p> The remote interface must
048: * extend the javax.ejb.EJBObject interface, and define the enterprise Bean
049: * specific business methods.
050: *
051: * <p> The enterprise Bean's remote interface is defined by the enterprise
052: * Bean provider and implemented by the enterprise Bean container.
053: */
054: public interface EJBObject extends java.rmi.Remote {
055: /**
056: * Obtain the enterprise Bean's remote home interface. The remote home
057: * interface defines the enterprise Bean's create, finder, remove,
058: * and home business methods.
059: *
060: * @return A reference to the enterprise Bean's home interface.
061: *
062: * @exception RemoteException Thrown when the method failed due to a
063: * system-level failure.
064: */
065: public EJBHome getEJBHome() throws RemoteException;
066:
067: /**
068: * Obtain the primary key of the EJB object.
069: *
070: * <p> This method can be called on an entity bean. An attempt to invoke
071: * this method on a session bean will result in RemoteException.
072: *
073: * @return The EJB object's primary key.
074: *
075: * @exception RemoteException Thrown when the method failed due to a
076: * system-level failure or when invoked on a session bean.
077: */
078: public Object getPrimaryKey() throws RemoteException;
079:
080: /**
081: * Remove the EJB object.
082: *
083: * @exception RemoteException Thrown when the method failed due to a
084: * system-level failure.
085: *
086: * @exception RemoveException The enterprise Bean or the container
087: * does not allow destruction of the object.
088: */
089: public void remove() throws RemoteException, RemoveException;
090:
091: /**
092: * Obtain a handle for the EJB object. The handle can be used at later
093: * time to re-obtain a reference to the EJB object, possibly in a
094: * different Java Virtual Machine.
095: *
096: * @return A handle for the EJB object.
097: *
098: * @exception RemoteException Thrown when the method failed due to a
099: * system-level failure.
100: */
101: public Handle getHandle() throws RemoteException;
102:
103: /**
104: * Test if a given EJB object is identical to the invoked EJB object.
105: *
106: * @param obj An object to test for identity with the invoked object.
107: *
108: * @return True if the given EJB object is identical to the invoked object,
109: * false otherwise.
110: *
111: * @exception RemoteException Thrown when the method failed due to a
112: * system-level failure.
113: */
114: boolean isIdentical(EJBObject obj) throws RemoteException;
115: }
|