javax.ejb.EJBLocalHome Maven / Gradle / Ivy
Show all versions of javax.ejb-api Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2018 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.ejb;
/**
* The EJBLocalHome interface must be extended by all enterprise
* beans' local home interfaces. An enterprise bean's local home
* interface defines the methods that allow local clients to create,
* find, and remove EJB objects.
*
* The local home interface is defined by the enterprise bean provider
* and implemented by the enterprise bean container.
*
* Enterprise beans written to the EJB 3.0 and later APIs do not require
* a local home interface.
*
* @since EJB 2.0
*/
public interface EJBLocalHome {
/**
* Remove an EJB object identified by its primary key.
*
*
This method can only be used by local clients of an entity
* bean. An attempt to call this method on a session bean will
* result in a RemoveException.
*
*
Note: Support for entity beans is optional as of EJB 3.2.
*
* @param primaryKey the primary key of the EJB object to be removed
*
* @exception RemoveException Thrown if the enterprise bean or
* the container does not allow the client to remove the object.
*
* @exception EJBException Thrown when the method failed due to a
* system-level failure.
*
*/
void remove(Object primaryKey) throws RemoveException, EJBException;
}