Jakarta EE 11.0.0 · jakarta.ejb.EJBObject · APIdia, the JavaDoc alternative

The EJBObject interface is extended by all enterprise beans' remote interfaces. An enterprise bean's remote interface provides the remote client view of an enterprise bean object. An enterprise bean's remote interface defines the business methods callable by a remote client.

The remote interface must extend the jakarta.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.

Method Summary

Modifier and Type	Method 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 enterprise bean object. getHandle() Obtain a handle for the enterprise bean object.
public Object	Returns: The enterprise bean object's primary key. getPrimaryKey() Obtain the primary key of the enterprise bean object.
public boolean	Returns: True if the given enterprise bean 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 enterprise bean object is identical to the invoked enterprise bean object.
public void	remove() Remove the enterprise bean object.

Method Detail

getEJBHome	back 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.

getEJBHome

back 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.

getHandle	back to summary
public Handle getHandle() throws RemoteException Obtain a handle for the enterprise bean object. The handle can be used at later time to re-obtain a reference to the enterprise bean object, possibly in a different Java Virtual Machine. Returns:Handle A handle for the enterprise bean object. Exceptions RemoteException: Thrown when the method failed due to a system-level failure.

getHandle

back to summary

public Handle getHandle() throws RemoteException

Obtain a handle for the enterprise bean object. The handle can be used at later time to re-obtain a reference to the enterprise bean object, possibly in a different Java Virtual Machine.

Returns:Handle

A handle for the enterprise bean object.

Exceptions

RemoteException:: Thrown when the method failed due to a system-level failure.

getPrimaryKey	back to summary
public Object getPrimaryKey() throws RemoteException Obtain the primary key of the enterprise bean 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 enterprise bean object's primary key. Exceptions RemoteException: Thrown when the method failed due to a system-level failure or when invoked on a session bean.

getPrimaryKey

back to summary

public Object getPrimaryKey() throws RemoteException

Obtain the primary key of the enterprise bean 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 enterprise bean object's primary key.

Exceptions

RemoteException:: Thrown when the method failed due to a system-level failure or when invoked on a session bean.

isIdentical	back to summary
public boolean isIdentical(EJBObject obj) throws RemoteException Test if a given enterprise bean object is identical to the invoked enterprise bean object. Parameters obj:EJBObject An object to test for identity with the invoked object. Returns:boolean True if the given enterprise bean object is identical to the invoked object, false otherwise. Exceptions RemoteException: Thrown when the method failed due to a system-level failure.

isIdentical

back to summary

public boolean isIdentical(EJBObject obj) throws RemoteException

Test if a given enterprise bean object is identical to the invoked enterprise bean object.

Parameters

obj:EJBObject: An object to test for identity with the invoked object.

Returns:boolean

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

Exceptions

RemoteException:: Thrown when the method failed due to a system-level failure.

remove	back to summary
public void remove() throws RemoteException, RemoveException Remove the enterprise bean 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.

remove

back to summary

public void remove() throws RemoteException, RemoveException

Remove the enterprise bean 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.

public Interface EJBObject

Method Summary

Method Detail