public interface EntityContext extends EJBContext
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 enterprise bean objects during the instance's life cycle.
Note: Support for entity beans is optional as of EJB 3.2.
Modifier and Type | Method and Description |
---|---|
EJBLocalObject |
getEJBLocalObject()
Obtain a reference to the enterprise bean local object that is currently associated with the instance.
|
EJBObject |
getEJBObject()
Obtain a reference to the enterprise bean object that is currently associated with the instance.
|
java.lang.Object |
getPrimaryKey()
Obtain the primary key of the enterprise bean object that is currently associated with this instance.
|
getCallerPrincipal, getContextData, getEJBHome, getEJBLocalHome, getRollbackOnly, getTimerService, getUserTransaction, isCallerInRole, lookup, setRollbackOnly
EJBLocalObject getEJBLocalObject() throws java.lang.IllegalStateException
An instance of an entity bean can call this method only when the instance is associated with an enterprise bean 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.
java.lang.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.EJBObject getEJBObject() throws java.lang.IllegalStateException
An instance of an entity bean can call this method only when the instance is associated with an enterprise bean 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.
java.lang.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.java.lang.Object getPrimaryKey() throws java.lang.IllegalStateException
An instance of an entity bean can call this method only when the instance is associated with an enterprise bean 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().
java.lang.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.