Top Description Methods
javax.ejb

public Interface EJBLocalObject

The EJBLocalObject interface must be extended by all enterprise beans' local interfaces. An enterprise bean's local interface provides the local client view of an EJB object. An enterprise bean's local interface defines the business methods callable by local clients.

The enterprise bean's local 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 local interface that extends the EJBLocalObject interface. A local business interface can be used instead.

Since
EJB 2.0

Method Summary

Modifier and TypeMethod and Description
public EJBLocalHome

Returns:

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

Obtain the enterprise bean's local home interface.

public Object

Returns:

The EJB local object's primary key.
getPrimaryKey()

Obtain the primary key of the EJB local object.

public boolean

Returns:

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

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

public void
remove()

Remove the EJB local object.

Method Detail

getEJBLocalHomeback to summary
public EJBLocalHome getEJBLocalHome() throws EJBException

Obtain the enterprise bean's local home interface. The local home interface defines the enterprise bean's create, finder, remove, and home business methods that are available to local clients.

Returns:EJBLocalHome

A reference to the enterprise bean's local home interface.

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

Obtain the primary key of the EJB local object.

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

Note

Support for entity beans is optional as of EJB 3.2.

Returns:Object

The EJB local object's primary key.

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

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

Parameters
obj:EJBLocalObject

An object to test for identity with the invoked object.

Returns:boolean

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

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

Remove the EJB local object.

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