| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>EJBObject</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="EJBObject"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/ejb/EJBMetaData.html" title="interface in jakarta.ejb"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/ejb/EJBs.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/ejb/EJBObject.html" target="_top">Frames</a></li> |
| <li><a href="EJBObject.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.ejb</div> |
| <h2 title="Interface EJBObject" class="title">Interface EJBObject</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>java.rmi.Remote</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">EJBObject</span> |
| extends java.rmi.Remote</pre> |
| <div class="block">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. |
| |
| <p> |
| The remote interface must extend the jakarta.ejb.EJBObject interface, and define the enterprise bean specific |
| business methods. |
| |
| <p> |
| The enterprise bean's remote interface is defined by the enterprise bean provider and implemented by the enterprise |
| bean container. |
| |
| <p> |
| 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.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>EJB 1.0</dd> |
| <dt><span class="simpleTagLabel">Examples (en):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/examples/component-interfaces.html">component-interfaces</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../jakarta/ejb/EJBHome.html" title="interface in jakarta.ejb">EJBHome</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/EJBObject.html#getEJBHome--">getEJBHome</a></span>()</code> |
| <div class="block">Obtain the enterprise bean's remote home interface.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../jakarta/ejb/Handle.html" title="interface in jakarta.ejb">Handle</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/EJBObject.html#getHandle--">getHandle</a></span>()</code> |
| <div class="block">Obtain a handle for the enterprise bean object.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/EJBObject.html#getPrimaryKey--">getPrimaryKey</a></span>()</code> |
| <div class="block">Obtain the primary key of the enterprise bean object.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/EJBObject.html#isIdentical-jakarta.ejb.EJBObject-">isIdentical</a></span>(<a href="../../jakarta/ejb/EJBObject.html" title="interface in jakarta.ejb">EJBObject</a> obj)</code> |
| <div class="block">Test if a given enterprise bean object is identical to the invoked enterprise bean object.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/EJBObject.html#remove--">remove</a></span>()</code> |
| <div class="block">Remove the enterprise bean object.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getEJBHome--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEJBHome</h4> |
| <pre><a href="../../jakarta/ejb/EJBHome.html" title="interface in jakarta.ejb">EJBHome</a> getEJBHome() |
| throws java.rmi.RemoteException</pre> |
| <div class="block">Obtain the enterprise bean's remote home interface. The remote home interface defines the enterprise bean's create, |
| finder, remove, and home business methods.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A reference to the enterprise bean's home interface.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.rmi.RemoteException</code> - Thrown when the method failed due to a system-level failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPrimaryKey--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKey</h4> |
| <pre>java.lang.Object getPrimaryKey() |
| throws java.rmi.RemoteException</pre> |
| <div class="block">Obtain the primary key of the enterprise bean object. |
| |
| <p> |
| This method can be called on an entity bean. An attempt to invoke this method on a session bean will result in |
| RemoteException. |
| |
| <p> |
| <b>Note:</b> Support for entity beans is optional as of EJB 3.2.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The enterprise bean object's primary key.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.rmi.RemoteException</code> - Thrown when the method failed due to a system-level failure or when invoked on a session |
| bean.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="remove--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre>void remove() |
| throws java.rmi.RemoteException, |
| <a href="../../jakarta/ejb/RemoveException.html" title="class in jakarta.ejb">RemoveException</a></pre> |
| <div class="block">Remove the enterprise bean object.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.rmi.RemoteException</code> - Thrown when the method failed due to a system-level failure.</dd> |
| <dd><code><a href="../../jakarta/ejb/RemoveException.html" title="class in jakarta.ejb">RemoveException</a></code> - The enterprise bean or the container does not allow destruction of the object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHandle--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHandle</h4> |
| <pre><a href="../../jakarta/ejb/Handle.html" title="interface in jakarta.ejb">Handle</a> getHandle() |
| throws java.rmi.RemoteException</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A handle for the enterprise bean object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.rmi.RemoteException</code> - Thrown when the method failed due to a system-level failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isIdentical-jakarta.ejb.EJBObject-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isIdentical</h4> |
| <pre>boolean isIdentical(<a href="../../jakarta/ejb/EJBObject.html" title="interface in jakarta.ejb">EJBObject</a> obj) |
| throws java.rmi.RemoteException</pre> |
| <div class="block">Test if a given enterprise bean object is identical to the invoked enterprise bean object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>obj</code> - An object to test for identity with the invoked object.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if the given enterprise bean object is identical to the invoked object, false otherwise.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.rmi.RemoteException</code> - Thrown when the method failed due to a system-level failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/ejb/EJBMetaData.html" title="interface in jakarta.ejb"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/ejb/EJBs.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/ejb/EJBObject.html" target="_top">Frames</a></li> |
| <li><a href="EJBObject.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
