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

EntityContext

public interface EntityContext implements EJBContext

The EntityContext interface provides an instance with access to the container-provided runtime context of an entity enterprise Bean instance. The container passes the EntityContext interface to an entity enterprise Bean instance after the instance has been created.

The EntityContext interface remains associated with the instance for the lifetime of the instance. Note that the information that the instance obtains using the EntityContext interface (such as the result of the getPrimaryKey() method) may change, as the container assigns the instance to different EJB objects during the instance's life cycle.

Fields Summary
Constructors Summary
Methods Summary
public EJBLocalObject getEJBLocalObject()
Obtain a reference to the EJB local object that is currently associated with the instance.
An instance of an entity enterprise Bean can call this method only when the instance is associated with an EJB local object identity, i.e. in the ejbActivate, ejbPassivate, ejbPostCreate, ejbRemove, ejbLoad, ejbStore, and business methods.
An instance can use this method, for example, when it wants to pass a reference to itself in a method argument or result.
return
The EJB local object currently associated with the instance.
exception
IllegalStateException if the instance invokes this method while the instance is in a state that does not allow the instance to invoke this method, or if the instance does not have a local interface.
public EJBObject getEJBObject()
Obtain a reference to the EJB object that is currently associated with the instance.
An instance of an entity enterprise Bean can call this method only when the instance is associated with an EJB object identity, i.e. in the ejbActivate, ejbPassivate, ejbPostCreate, ejbRemove, ejbLoad, ejbStore, and business methods.
An instance can use this method, for example, when it wants to pass a reference to itself in a method argument or result.
return
The EJB object currently associated with the instance.
exception
IllegalStateException Thrown if the instance invokes this method while the instance is in a state that does not allow the instance to invoke this method, or if the instance does not have a remote interface.
public java.lang.Object getPrimaryKey()
Obtain the primary key of the EJB object that is currently associated with this instance.
An instance of an entity enterprise Bean can call this method only when the instance is associated with an EJB object identity, i.e. in the ejbActivate, ejbPassivate, ejbPostCreate, ejbRemove, ejbLoad, ejbStore, and business methods.
Note: The result of this method is that same as the result of getEJBObject().getPrimaryKey().
return
The primary key currently associated with the instance.
exception
IllegalStateException Thrown if the instance invokes this method while the instance is in a state that does not allow the instance to invoke this method.