File Doc Category Size Date Package
EJBObject.java API Doc Glassfish v2 API 4780 Fri May 04 22:35:54 BST 2007 javax.ejb

EJBObject

public interface EJBObject implements Remote

The EJBObject interface is extended by all enterprise Beans' remote interfaces. An enterprise Bean's remote interface provides the remote client view of an EJB object. An enterprise Bean's remote interface defines the business methods callable by a remote client.

The remote interface must extend the javax.ejb.EJBObject interface, and define the enterprise Bean specific business methods.

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

Fields Summary
Constructors Summary
Methods Summary
public EJBHome getEJBHome()
Obtain the enterprise Bean's remote home interface. The remote home interface defines the enterprise Bean's create, finder, remove, and home business methods.
return
A reference to the enterprise Bean's home interface.
exception
RemoteException Thrown when the method failed due to a system-level failure.
public Handle getHandle()
Obtain a handle for the EJB object. The handle can be used at later time to re-obtain a reference to the EJB object, possibly in a different Java Virtual Machine.
return
A handle for the EJB object.
exception
RemoteException Thrown when the method failed due to a system-level failure.
public java.lang.Object getPrimaryKey()
Obtain the primary key of the EJB object.
This method can be called on an entity bean. An attempt to invoke this method on a session bean will result in RemoteException.
return
The EJB object's primary key.
exception
RemoteException Thrown when the method failed due to a system-level failure or when invoked on a session bean.
public boolean isIdentical(javax.ejb.EJBObject obj)
Test if a given EJB object is identical to the invoked EJB object.
param
obj An object to test for identity with the invoked object.
return
True if the given EJB object is identical to the invoked object, false otherwise.
exception
RemoteException Thrown when the method failed due to a system-level failure.
public void remove()
Remove the EJB object.
exception
RemoteException Thrown when the method failed due to a system-level failure.
exception
RemoveException The enterprise Bean or the container does not allow destruction of the object.