Home » openejb-3.1.2-src » javax » ejb » [javadoc | source]
javax.ejb
public interface: EntityContext [javadoc | source]

All Implemented Interfaces:
    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 from javax.ejb.EntityContext Summary:
getEJBLocalObject,   getEJBObject,   getPrimaryKey
Method from javax.ejb.EntityContext Detail:
 public EJBLocalObject getEJBLocalObject() throws IllegalStateException

    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.

 public 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, 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.

 public 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, ejbRemove, ejbLoad, ejbStore, and business methods.

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