1. /*

  2.  * Copyright 2002 Sun Microsystems, Inc. All rights reserved.

  3.  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

  4.  */

  5. package javax.ejb;

  6. 

  7. import java.rmi.RemoteException;

  8. 

  9. 

  10. /**

  11.  * The EntityBean interface is implemented by every entity enterprise Bean 

  12.  * class. The container uses the EntityBean methods to notify the enterprise

  13.  * Bean instances of the instance's life cycle events.

  14.  */

  15. public interface EntityBean extends EnterpriseBean {

  16.     /**

  17.      * Set the associated entity context. The container invokes this method

  18.      * on an instance after the instance has been created.

  19.      *

  20.      * <p> This method is called in an unspecified transaction context.

  21.      *

  22.      * @param ctx An EntityContext interface for the instance. The instance

  23.      *    should store the reference to the context in an instance variable.

  24.      *

  25.      * @exception EJBException Thrown by the method to indicate a failure

  26.      *    caused by a system-level error. 

  27.      *

  28.      * @exception RemoteException This exception is defined in the method

  29.      *    signature to provide backward compatibility for enterprise beans 

  30.      *    written for the EJB 1.0 specification. Enterprise beans written 

  31.      *    for the EJB 1.1 specification should throw the

  32.      *    javax.ejb.EJBException instead of this exception.

  33.      *    Enterprise beans written for the EJB2.0 and higher specifications

  34.      *    must throw the javax.ejb.EJBException instead of this exception.

  35.      */

  36.     public void setEntityContext(EntityContext ctx) throws EJBException,

  37.             RemoteException;

  38. 

  39.     /**

  40.      * Unset the associated entity context. The container calls this method

  41.      * before removing the instance.

  42.      *

  43.      * <p> This is the last method that the container invokes on the instance.

  44.      * The Java garbage collector will eventually invoke the finalize() method

  45.      * on the instance.

  46.      *

  47.      * <p> This method is called in an unspecified transaction context.

  48.      *

  49.      * @exception EJBException Thrown by the method to indicate a failure

  50.      *    caused by a system-level error. 

  51.      *

  52.      * @exception RemoteException This exception is defined in the method

  53.      *    signature to provide backward compatibility for enterprise beans 

  54.      *    written for the EJB 1.0 specification. Enterprise beans written 

  55.      *    for the EJB 1.1 specification should throw the

  56.      *    javax.ejb.EJBException instead of this exception.

  57.      *    Enterprise beans written for the EJB2.0 and higher specifications

  58.      *    must throw the javax.ejb.EJBException instead of this exception.

  59.      */

  60.     public void unsetEntityContext() throws EJBException, RemoteException;

  61. 

  62.     /**

  63.      * A container invokes this method before it removes the EJB object

  64.      * that is currently associated with the instance. This method

  65.      * is invoked when a client invokes a remove operation on the

  66.      * enterprise Bean's home interface or the EJB object's remote interface.

  67.      * This method transitions the instance from the ready state to the pool 

  68.      * of available instances.

  69.      * 

  70.      * <p> This method is called in the transaction context of the remove 

  71.      * operation.

  72.      *

  73.      * @exception RemoveException The enterprise Bean does not allow

  74.      *    destruction of the object.

  75.      *

  76.      * @exception EJBException Thrown by the method to indicate a failure

  77.      *    caused by a system-level error.

  78.      *

  79.      * @exception RemoteException This exception is defined in the method

  80.      *    signature to provide backward compatibility for enterprise beans 

  81.      *    written for the EJB 1.0 specification. Enterprise beans written 

  82.      *    for the EJB 1.1 specification should throw the

  83.      *    javax.ejb.EJBException instead of this exception.

  84.      *    Enterprise beans written for the EJB2.0 and higher specifications

  85.      *    must throw the javax.ejb.EJBException instead of this exception.

  86.      */

  87.     public void ejbRemove() throws RemoveException, EJBException, 

  88. 	RemoteException;

  89. 

  90.     /**

  91.      * A container invokes this method when the instance

  92.      * is taken out of the pool of available instances to become associated

  93.      * with a specific EJB object. This method transitions the instance to 

  94.      * the ready state.

  95.      *

  96.      * <p> This method executes in an unspecified transaction context.

  97.      *

  98.      * @exception EJBException Thrown by the method to indicate a failure

  99.      *    caused by a system-level error.

  100.      *

  101.      * @exception RemoteException This exception is defined in the method

  102.      *    signature to provide backward compatibility for enterprise beans 

  103.      *    written for the EJB 1.0 specification. Enterprise beans written 

  104.      *    for the EJB 1.1 specification should throw the

  105.      *    javax.ejb.EJBException instead of this exception.

  106.      *    Enterprise beans written for the EJB2.0 and higher specifications

  107.      *    must throw the javax.ejb.EJBException instead of this exception.

  108.      */

  109.     public void ejbActivate() throws EJBException, RemoteException;

  110. 

  111.     /**

  112.      * A container invokes this method on an instance before the instance

  113.      * becomes disassociated with a specific EJB object. After this method

  114.      * completes, the container will place the instance into the pool of

  115.      * available instances.

  116.      *

  117.      * <p> This method executes in an unspecified transaction context.

  118.      *

  119.      * @exception EJBException Thrown by the method to indicate a failure

  120.      *    caused by a system-level error.

  121.      *

  122.      * @exception RemoteException This exception is defined in the method

  123.      *    signature to provide backward compatibility for enterprise beans 

  124.      *    written for the EJB 1.0 specification. Enterprise beans written 

  125.      *    for the EJB 1.1 specification should throw the

  126.      *    javax.ejb.EJBException instead of this exception.

  127.      *    Enterprise beans written for the EJB2.0 and higher specifications

  128.      *    must throw the javax.ejb.EJBException instead of this exception.

  129.      */

  130.     public void ejbPassivate() throws EJBException, RemoteException;

  131. 

  132.     /**

  133.      * A container invokes this method to instruct the

  134.      * instance to synchronize its state by loading it state from the

  135.      * underlying database.

  136.      * 

  137.      * <p> This method always executes in the transaction context determined

  138.      * by the value of the transaction attribute in the deployment descriptor.

  139.      *

  140.      * @exception EJBException Thrown by the method to indicate a failure

  141.      *    caused by a system-level error.

  142.      *

  143.      * @exception RemoteException This exception is defined in the method

  144.      *    signature to provide backward compatibility for enterprise beans 

  145.      *    written for the EJB 1.0 specification. Enterprise beans written 

  146.      *    for the EJB 1.1 specification should throw the

  147.      *    javax.ejb.EJBException instead of this exception.

  148.      *    Enterprise beans written for the EJB2.0 and higher specifications

  149.      *    must throw the javax.ejb.EJBException instead of this exception.

  150.      */

  151.     public void ejbLoad() throws EJBException, RemoteException;

  152. 

  153.     /**

  154.      * A container invokes this method to instruct the

  155.      * instance to synchronize its state by storing it to the underlying 

  156.      * database.

  157.      *

  158.      * <p> This method always executes in the transaction context determined

  159.      * by the value of the transaction attribute in the deployment descriptor.

  160.      *

  161.      * @exception EJBException Thrown by the method to indicate a failure

  162.      *    caused by a system-level error.

  163.      *

  164.      * @exception RemoteException This exception is defined in the method

  165.      *    signature to provide backward compatibility for enterprise beans 

  166.      *    written for the EJB 1.0 specification. Enterprise beans written 

  167.      *    for the EJB 1.1 specification should throw the

  168.      *    javax.ejb.EJBException instead of this exception.

  169.      *    Enterprise beans written for the EJB2.0 and higher specifications

  170.      *    must throw the javax.ejb.EJBException instead of this exception.

  171.      */

  172.     public void ejbStore() throws EJBException, RemoteException;

  173. }

  174. 

  175.