All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface javax.ejb.EntityContext

public interface interface EntityContext
extends 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.

Method Index

o getEJBObject()
Obtain a reference to the EJB object that is currently associated with the instance.
o getPrimaryKey()
Obtain the primary key of the EJB object that is currently associated with this instance.

Methods

o getEJBObject 
 public abstract EJBObject getEJBObject() throws IllegalStateException
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 method, 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.

Returns:
The EJB object currently associated with the instance.
Throws: 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.
o getPrimaryKey 
 public abstract Object getPrimaryKey() throws IllegalStateException
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 method, ejbRemove, ejbLoad, ejbStore, and business methods.

Note: The result of this method is that same as the result of getEJBObject().getPrimaryKey().

Returns:
The EJB object currently associated with the instance.
Throws: 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. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index