Top Description Methods
javax.ejb

public Interface EJBObject

extends Remote
Known Direct Subinterfaces
javax.management.j2ee.Management
Imports
java.rmi.RemoteException
The EJBObject interface is extended by all enterprise beans' remote interfaces. An enterprise bean's remote interface provides the remote client view of an EJB object. An enterprise bean's remote interface defines the business methods callable by a remote client.

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.

Enterprise beans written to the EJB 3.0 and later APIs do not require a remote interface that extends the EJBObject interface. A remote business interface can be used instead.

Since
EJB 1.0

Method Summary

Modifier and TypeMethod and Description
public EJBHome

Returns:

A reference to the enterprise bean's home interface.
getEJBHome()

Obtain the enterprise bean's remote home interface.

public Handle

Returns:

A handle for the EJB object.
getHandle()

Obtain a handle for the EJB object.

public Object

Returns:

The EJB object's primary key.
getPrimaryKey()

Obtain the primary key of the EJB object.

public boolean

Returns:

True if the given EJB object is identical to the invoked object, false otherwise.
isIdentical(EJBObject
An object to test for identity with the invoked object.
obj)

Test if a given EJB object is identical to the invoked EJB object.

public void
remove()

Remove the EJB object.

Method Detail

getEJBHomeback to summary
public EJBHome getEJBHome() throws RemoteException

Obtain the enterprise bean's remote home interface. The remote home interface defines the enterprise bean's create, finder, remove, and home business methods.

Returns:EJBHome

A reference to the enterprise bean's home interface.

Exceptions
RemoteException:
Thrown when the method failed due to a system-level failure.
getHandleback to summary
public 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:Handle

A handle for the EJB object.

Exceptions
RemoteException:
Thrown when the method failed due to a system-level failure.
getPrimaryKeyback to summary
public Object getPrimaryKey() throws RemoteException

Obtain the primary key of the EJB object.

This method can be called on an entity bean. An attempt to invoke this method on a session bean will result in RemoteException.

Note

Support for entity beans is optional as of EJB 3.2.

Returns:Object

The EJB object's primary key.

Exceptions
RemoteException:
Thrown when the method failed due to a system-level failure or when invoked on a session bean.
isIdenticalback to summary
public boolean isIdentical(EJBObject obj) throws RemoteException

Test if a given EJB object is identical to the invoked EJB object.

Parameters
obj:EJBObject

An object to test for identity with the invoked object.

Returns:boolean

True if the given EJB object is identical to the invoked object, false otherwise.

Exceptions
RemoteException:
Thrown when the method failed due to a system-level failure.
removeback to summary
public void remove() throws RemoteException, RemoveException

Remove the EJB object.

Exceptions
RemoteException:
Thrown when the method failed due to a system-level failure.
RemoveException:
The enterprise bean or the container does not allow destruction of the object.