All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface javax.ejb.EntityContext

public interface interface EntityContext
extends InstanceContext
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.
 o setPrimaryKey(Object)
Associate the primary key with the EJB object that is being currently created.

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 in the "ready" state, i.e. after and within the ejbActivate or ejbCreate method, and before the ejbPassivate or ejbDestroy method. If the instance calls this method from the ejbCreate method, it may do it only after it called setPrimaryKey.

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 entity enterprise bean instance can call this method only when the instance is in the ready state; from the ejbActivate(), ejbPassivate(), and ejbDestroy() methods; and from the ejbCreate(...) methods after the instance has called the set primary key method on the InstanceContext interface.

Note: The result of this method is that same as the 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.
 o setPrimaryKey
 public abstract void setPrimaryKey(Object primaryKey) throws IllegalStateException, DuplicateKeyException
Associate the primary key with the EJB object that is being currently created. This method is callable only from the ejbCreate(...) methods of an entity enterprise bean class.

Throws: DuplicateKeyException
Thrown if creating of the entity would result in creation of a record with duplicate primary key. This exception is thrown only if the entity bean uses container managed persistence.
Throws: IllegalStateException
Thrown if the instance invokes this method from a method other than ejbCreate(...).

All Packages  Class Hierarchy  This Package  Previous  Next  Index