Module jakarta.ejb

Package jakarta.ejb

Interface EJBLocalHome

public interface EJBLocalHome

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 enterprise bean 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

Method Summary

Modifier and Type	Method	Description
void	remove(Object primaryKey)	Remove an enterprise bean object identified by its primary key.

Method Details

remove

void remove(Object primaryKey)
     throws RemoveException,
EJBException

Remove an enterprise bean 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.

Parameters:

primaryKey - the primary key of the enterprise bean object to be removed

Throws:

RemoveException - Thrown if the enterprise bean or the container does not allow the client to remove the object.

EJBException - Thrown when the method failed due to a system-level failure.