Save This Page
Home » openejb-3.1.2-src » javax » ejb » [javadoc | source]
    1   /*
    2   * JBoss, Home of Professional Open Source
    3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
    4   * by the @authors tag. See the copyright.txt in the distribution for a
    5   * full listing of individual contributors.
    6   *
    7   * This is free software; you can redistribute it and/or modify it
    8   * under the terms of the GNU Lesser General Public License as
    9   * published by the Free Software Foundation; either version 2.1 of
   10   * the License, or (at your option) any later version.
   11   *
   12   * This software is distributed in the hope that it will be useful,
   13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   15   * Lesser General Public License for more details.
   16   *
   17   * You should have received a copy of the GNU Lesser General Public
   18   * License along with this software; if not, write to the Free
   19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
   20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
   21   */
   22   package javax.ejb;
   23   
   24   import java.rmi.RemoteException;
   25   
   26   /**
   27    * <P>The EJBHome interface must be extended by all enterprise Beans' remote home interfaces.
   28    * An enterprise Bean's remote home interface defines the methods that allow a remote client to
   29    * create, find, and remove EJB objects, as well as home business methods that are not specific to
   30    * a bean instance (Session Beans do not have finders and home methods).</P>
   31    *
   32    * <P>The remote home interface is defined by the enterprise Bean provider and implemented by the
   33    * enterprise Bean container.</P>
   34    */
   35   public interface EJBHome extends java.rmi.Remote {
   36   
   37      /**
   38       * Remove an EJB object identified by its handle.
   39       *
   40       * @exception java.rmi.RemoteException - Thrown when the method failed due to a system-level failure.
   41       * @exception RemoveException - Thrown if the enterprise Bean or the container does not allow
   42       * the client to remove the object.
   43       */
   44      public void remove(Handle handle) throws RemoteException, RemoveException;
   45   
   46      /**
   47       * <P>Remove an EJB object identified by its primary key.</P>
   48       *
   49       * <P>This method can be used only for an entity bean. An attempt to call this method on
   50       * a session bean will result in a RemoteException.</P>
   51       *
   52       * @exception java.rmi.RemoteException - Thrown when the method failed due to a system-level failure.
   53       * @exception RemoveException - Thrown if the enterprise Bean or the container does not allow
   54       * the client to remove the object.
   55       */
   56      public void remove(Object primaryKey) throws RemoteException, RemoveException;
   57   
   58     /**
   59      * <P>Obtain the EJBMetaData interface for the enterprise Bean. The EJBMetaData interface allows
   60      * the client to obtain information about the enterprise Bean.</P>
   61      *
   62      * <P>The information obtainable via the EJBMetaData interface is intended to be used by tools.</P>
   63      *
   64      * @return The enterprise Bean's EJBMetaData interface.
   65      * @exception java.rmi.RemoteException - Thrown when the method failed due to a system-level failure.
   66      */
   67     public EJBMetaData getEJBMetaData() throws RemoteException;
   68   
   69     /**
   70      * Obtain a handle for the remote home object. The handle can be used at later time to re-obtain
   71      * a reference to the remote home object, possibly in a different Java Virtual Machine.
   72      *
   73      * @return A handle for the remote home object.
   74      * @exception java.rmi.RemoteException - Thrown when the method failed due to a system-level failure.
   75      */
   76     public HomeHandle getHomeHandle() throws RemoteException;
   77   
   78   }

Save This Page
Home » openejb-3.1.2-src » javax » ejb » [javadoc | source]