Top Description Methods
javax.ejb

public Interface EJBHome

extends Remote
Known Direct Subinterfaces
javax.management.j2ee.ManagementHome
Imports
java.rmi.RemoteException
The EJBHome interface must be extended by all enterprise beans' remote home interfaces. An enterprise bean's remote home interface defines the methods that allow a remote client to create, find, and remove EJB objects.

The remote 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 home interface.

Since
EJB 1.0

Method Summary

Modifier and TypeMethod and Description
public EJBMetaData

Returns:

The enterprise Bean's EJBMetaData interface.
getEJBMetaData()

Obtain the EJBMetaData interface for the enterprise bean.

public HomeHandle

Returns:

A handle for the remote home object.
getHomeHandle()

Obtain a handle for the remote home object.

public void
remove(Handle
the handle of the EJB object to be removed
handle)

Remove an EJB object identified by its handle.

public void
remove(Object
the primary key of the EJB object to be removed
primaryKey)

Remove an EJB object identified by its primary key.

Method Detail

getEJBMetaDataback to summary
public EJBMetaData getEJBMetaData() throws RemoteException

Obtain the EJBMetaData interface for the enterprise bean. The EJBMetaData interface allows the client to obtain information about the enterprise bean.

The information obtainable via the EJBMetaData interface is intended to be used by tools.

Returns:EJBMetaData

The enterprise Bean's EJBMetaData interface.

Exceptions
RemoteException:
Thrown when the method failed due to a system-level failure.
getHomeHandleback to summary
public HomeHandle getHomeHandle() throws RemoteException

Obtain a handle for the remote home object. The handle can be used at later time to re-obtain a reference to the remote home object, possibly in a different Java Virtual Machine.

Returns:HomeHandle

A handle for the remote home object.

Exceptions
RemoteException:
Thrown when the method failed due to a system-level failure.
Since
EJB 1.1
removeback to summary
public void remove(Handle handle) throws RemoteException, RemoveException

Remove an EJB object identified by its handle.

Parameters
handle:Handle

the handle of the EJB object to be removed

Exceptions
RemoteException:
Thrown when the method failed due to a system-level failure.
RemoveException:
Thrown if the enterprise bean or the container does not allow the client to remove the object.
removeback to summary
public void remove(Object primaryKey) throws RemoteException, RemoveException

Remove an EJB object identified by its primary key.

This method can be used only for 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:Object

the primary key of the EJB object to be removed

Exceptions
RemoteException:
Thrown when the method failed due to a system-level failure.
RemoveException:
Thrown if the enterprise bean or the container does not allow the client to remove the object.