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:
037: package javax.ejb;
038:
039: /**
040: * The EJBLocalObject interface must be extended by all enterprise Beans' local
041: * interfaces. An enterprise Bean's local interface provides the local client
042: * view of an EJB object. An enterprise Bean's local interface defines
043: * the business methods callable by local clients.
044: *
045: * <p> The enterprise Bean's local interface is defined by the enterprise
046: * Bean provider and implemented by the enterprise Bean container.
047: */
048: public interface EJBLocalObject {
049: /**
050: * Obtain the enterprise Bean's local home interface. The local home
051: * interface defines the enterprise Bean's create, finder, remove,
052: * and home business methods that are available to local clients.
053: *
054: * @return A reference to the enterprise Bean's local home interface.
055: *
056: * @exception EJBException Thrown when the method failed due to a
057: * system-level failure.
058: *
059: */
060: public EJBLocalHome getEJBLocalHome() throws EJBException;
061:
062: /**
063: * Obtain the primary key of the EJB local object.
064: *
065: * <p> This method can be called on an entity bean.
066: * An attempt to invoke this method on a session Bean will result in
067: * an EJBException.
068: *
069: * @return The EJB local object's primary key.
070: *
071: * @exception EJBException Thrown when the method failed due to a
072: * system-level failure or when invoked on a session bean.
073: *
074: */
075: public Object getPrimaryKey() throws EJBException;
076:
077: /**
078: * Remove the EJB local object.
079: *
080: * @exception RemoveException The enterprise Bean or the container
081: * does not allow destruction of the object.
082: *
083: * @exception EJBException Thrown when the method failed due to a
084: * system-level failure.
085: *
086: */
087: public void remove() throws RemoveException, EJBException;
088:
089: /**
090: * Test if a given EJB local object is identical to the invoked EJB
091: * local object.
092: *
093: * @param obj An object to test for identity with the invoked object.
094: *
095: * @return True if the given EJB local object is identical to the
096: * invoked object, false otherwise.
097: *
098: *
099: * @exception EJBException Thrown when the method failed due to a
100: * system-level failure.
101: *
102: */
103: boolean isIdentical(EJBLocalObject obj) throws EJBException;
104: }
|