EJBLocalHome (Java 2 Platform Ent. Ed. v1.4) - Java Platform, Enterprise Edition v1.4 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java^TM 2 Platform
Ent. Ed. v1.4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.ejb
Interface EJBLocalHome

public interface EJBLocalHome

The EJBLocalHome interface must be extended by all enterprise Beans' local home interfaces. An enterprise Bean's local home interface defines the methods that allow local clients to create, find, and remove EJB objects, as well as home business methods that are not specific to a bean instance (session Beans do not have finders and home business methods).

The local home interface is defined by the enterprise Bean provider and implemented by the enterprise Bean container.

Method Summary

void remove(Object primaryKey)
Remove an EJB object identified by its primary key.

Method Detail

remove

public void remove(Object primaryKey)
            throws RemoveException,
                   EJBException

Remove an EJB object identified by its primary key.

This method can only be used by local clients of an entity bean. An attempt to call this method on a session bean will result in a RemoveException.

Throws:: RemoveException - Thrown if the enterprise Bean or the container does not allow the client to remove the object.; EJBException - Thrown when the method failed due to a system-level failure.