FileDocCategorySizeDatePackage
EJBHome.javaAPI DocGlassfish v2 API4513Fri May 04 22:35:54 BST 2007javax.ejb

EJBHome

public interface EJBHome implements Remote
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, as well as home business methods that are not specific to a bean instance (Session Beans do not have finders and home methods).

The remote home interface is defined by the enterprise Bean provider and implemented by the enterprise Bean container.

Fields Summary
Constructors Summary
Methods Summary
public EJBMetaDatagetEJBMetaData()
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.

return
The enterprise Bean's EJBMetaData interface.
exception
RemoteException Thrown when the method failed due to a system-level failure.

public HomeHandlegetHomeHandle()
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.

return
A handle for the remote home object.
exception
RemoteException Thrown when the method failed due to a system-level failure.

public voidremove(Handle handle)
Remove an EJB object identified by its handle.

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

public voidremove(java.lang.Object primaryKey)
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.

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