All Packages Class Hierarchy This Package Previous Next Index
Interface javax.ejb.EJBObject
- public interface interface EJBObject
- extends Remote
The EJBObject interface is an interface that is extended by all enterprise
bean's remote interface. An enterprise bean's remote interface provides
the client's view of an EJB object. An enterprise bean's remote defines
the business methods callable by a client.
Each enterprise bean has a remote interface. The remote interface must
extend the javax.ejb.EJBObject interface, and define the enterprise bean
specific business methods.
The enterprise bean's remote interface is defined by the enterprise
bean provider and implemented by the enterprise bean container.
-
destroy()
- Destroy the EJB object.
-
getEJBHome()
- Obtain the enterprise bean's home interface.
-
getHandle()
- Obtain a handle for the EJB object.
-
getPrimaryKey()
- Obtain the primary key of the EJB object.
-
isIdentical(EJBObject)
- Test if a given EJB object is identical to the invoked EJB object.
getEJBHome
public abstract EJBHome getEJBHome() throws RemoteException
- Obtain the enterprise bean's home interface. The home interface defines
the enterprise bean's create, finder, and destroy operations.
- Returns:
- A reference to the enterprise bean's home interface.
- Throws: RemoteException
- Thrown when the method failed due to a
system-level failure.
getPrimaryKey
public abstract Object getPrimaryKey() throws RemoteException
- Obtain the primary key of the EJB object.
- Returns:
- The EJB object's primary.
destroy
public abstract void destroy() throws RemoteException, DestroyException
- Destroy the EJB object.
- Throws: RemoteException
- Thrown when the method failed due to a
system-level failure.
- Throws: DestroyException
- The enterprise bean or the container
does not allow destruction of the object.
getHandle
public abstract Handle getHandle() throws RemoteException
- Obtain a handle for the EJB object. The handle can be used at later
time to re-obtain a reference to the EJB object, possibly in a
different Java Virtual Machine.
- Returns:
- A handle for the EJB object.
- Throws: RemoteException
- Thrown when the method failed due to a
system-level failure.
isIdentical
public abstract boolean isIdentical(EJBObject obj) throws RemoteException
- Test if a given EJB object is identical to the invoked EJB object.
- Parameters:
- obj - An object to test for identity with the invoked object.
- Returns:
- True if the given EJB object is identical to the invoked object,
false otherwise.
- Throws: RemoteException
- Thrown when the method failed due to a
system-level failure.
All Packages Class Hierarchy This Package Previous Next Index