blob: 1bffe4c85f2872c5ecb794f72af4be4a676217e3 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:39:09 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>JpaEntityManager (EclipseLink 3.0.2, API Reference)</title>
<meta name="date" content="2021-07-16">
<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="JpaEntityManager (EclipseLink 3.0.2, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":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 class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/persistence/jpa/JpaCriteriaBuilder.html" title="interface in org.eclipse.persistence.jpa"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManagerFactory.html" title="interface in org.eclipse.persistence.jpa"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/persistence/jpa/JpaEntityManager.html" target="_top">Frames</a></li>
<li><a href="JpaEntityManager.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">org.eclipse.persistence.jpa</div>
<h2 title="Interface JpaEntityManager" class="title">Interface JpaEntityManager</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, jakarta.persistence.EntityManager</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">JpaEntityManager</span>
extends jakarta.persistence.EntityManager, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></pre>
<div class="block"><p>
<b>Purpose</b>: Defines the Interface for EclipseLink extensions to the EntityManager
</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>EntityManager</code></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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#copy-java.lang.Object-org.eclipse.persistence.queries.AttributeGroup-">copy</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;entityOrEntities,
<a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html" title="class in org.eclipse.persistence.queries">AttributeGroup</a>&nbsp;group)</code>
<div class="block">This method will return copy the passed entity using the passed AttributeGroup.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>jakarta.persistence.Query</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#createDescriptorNamedQuery-java.lang.String-java.lang.Class-">createDescriptorNamedQuery</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queryName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;descriptorClass)</code>
<div class="block">This method will create a query object that wraps a EclipseLink Named Query.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>jakarta.persistence.Query</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#createDescriptorNamedQuery-java.lang.String-java.lang.Class-java.util.List-">createDescriptorNamedQuery</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queryName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;descriptorClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&nbsp;argumentTypes)</code>
<div class="block">This method will create a query object that wraps a EclipseLink Named Query.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>jakarta.persistence.Query</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#createQuery-org.eclipse.persistence.queries.Call-">createQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a>&nbsp;call)</code>
<div class="block">This method is used to create a query using a EclipseLink Call.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>jakarta.persistence.Query</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#createQuery-org.eclipse.persistence.queries.Call-java.lang.Class-">createQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a>&nbsp;call,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;entityClass)</code>
<div class="block">This method is used to create a query using a EclipseLink Call for the entity class.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>jakarta.persistence.Query</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#createQuery-org.eclipse.persistence.queries.DatabaseQuery-">createQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a>&nbsp;query)</code>
<div class="block">This method is used to create a query using a EclipseLink DatabaseQuery.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>jakarta.persistence.Query</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#createQuery-org.eclipse.persistence.expressions.Expression-java.lang.Class-">createQuery</a></span>(<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&nbsp;expression,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;entityClass)</code>
<div class="block">This method is used to create a query using a EclipseLink Expression for the entity class.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>jakarta.persistence.Query</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#createQueryByExample-java.lang.Object-">createQueryByExample</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;exampleObject)</code>
<div class="block">This method is used to create a query using query by example.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#getAbstractSession--">getAbstractSession</a></span>()</code>
<div class="block">Return the underlying database session</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#getActiveSession--">getActiveSession</a></span>()</code>
<div class="block">This method returns the current session to the requester.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.sessions.DatabaseSessionImpl</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#getDatabaseSession--">getDatabaseSession</a></span>()</code>
<div class="block">Return the underlying database session</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#getMemberDatabaseSession-java.lang.Class-">getMemberDatabaseSession</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;cls)</code>
<div class="block">Return the member DatabaseSessionImpl that maps cls in session broker.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#getMemberServerSession-java.lang.Class-">getMemberServerSession</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;cls)</code>
<div class="block">Return the member ServerSession that maps cls in session broker.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#getMemberSessionName-java.lang.Class-">getMemberSessionName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;cls)</code>
<div class="block">Return the name of member session that maps cls.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#getServerSession--">getServerSession</a></span>()</code>
<div class="block">Return the underlying server session</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#getSession--">getSession</a></span>()</code>
<div class="block">This method will return a Session outside of a transaction and null within a transaction.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/sessions/broker/SessionBroker.html" title="class in org.eclipse.persistence.sessions.broker">SessionBroker</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#getSessionBroker--">getSessionBroker</a></span>()</code>
<div class="block">Return the underlying session broker</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/sessions/UnitOfWork.html" title="interface in org.eclipse.persistence.sessions">UnitOfWork</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#getUnitOfWork--">getUnitOfWork</a></span>()</code>
<div class="block">This method will return the transactional UnitOfWork during the transaction and null
outside of the transaction.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#isBroker--">isBroker</a></span>()</code>
<div class="block">Indicates whether the underlying session is a session broker.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManager.html#load-java.lang.Object-org.eclipse.persistence.queries.AttributeGroup-">load</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;entityOrEntities,
<a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html" title="class in org.eclipse.persistence.queries">AttributeGroup</a>&nbsp;group)</code>
<div class="block">This method will load the passed entity or collection of entities using the passed AttributeGroup.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.persistence.EntityManager">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;jakarta.persistence.EntityManager</h3>
<code>clear, close, contains, createEntityGraph, createEntityGraph, createNamedQuery, createNamedQuery, createNamedStoredProcedureQuery, createNativeQuery, createNativeQuery, createNativeQuery, createQuery, createQuery, createQuery, createQuery, createQuery, createStoredProcedureQuery, createStoredProcedureQuery, createStoredProcedureQuery, detach, find, find, find, find, flush, getCriteriaBuilder, getDelegate, getEntityGraph, getEntityGraphs, getEntityManagerFactory, getFlushMode, getLockMode, getMetamodel, getProperties, getReference, getTransaction, isJoinedToTransaction, isOpen, joinTransaction, lock, lock, merge, persist, refresh, refresh, refresh, refresh, remove, setFlushMode, setProperty, unwrap</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.AutoCloseable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code></li>
</ul>
</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="getActiveSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveSession</h4>
<pre><a href="../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a>&nbsp;getActiveSession()</pre>
<div class="block">This method returns the current session to the requester. The current session
will be the active UnitOfWork within a transaction and will be a 'scrap'
UnitOfWork outside of a transaction. The caller is concerned about the results
then the getSession() or getUnitOfWork() API should be called.</div>
</li>
</ul>
<a name="getAbstractSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAbstractSession</h4>
<pre>org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;getAbstractSession()</pre>
<div class="block">Return the underlying database session</div>
</li>
</ul>
<a name="getDatabaseSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatabaseSession</h4>
<pre>org.eclipse.persistence.internal.sessions.DatabaseSessionImpl&nbsp;getDatabaseSession()</pre>
<div class="block">Return the underlying database session</div>
</li>
</ul>
<a name="getServerSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerSession</h4>
<pre><a href="../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a>&nbsp;getServerSession()</pre>
<div class="block">Return the underlying server session</div>
</li>
</ul>
<a name="getSessionBroker--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionBroker</h4>
<pre><a href="../../../../org/eclipse/persistence/sessions/broker/SessionBroker.html" title="class in org.eclipse.persistence.sessions.broker">SessionBroker</a>&nbsp;getSessionBroker()</pre>
<div class="block">Return the underlying session broker</div>
</li>
</ul>
<a name="getMemberDatabaseSession-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMemberDatabaseSession</h4>
<pre>org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;getMemberDatabaseSession(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;cls)</pre>
<div class="block">Return the member DatabaseSessionImpl that maps cls in session broker.
Return null if either not a session broker or cls is not mapped.
Session broker implement composite persistence unit.</div>
</li>
</ul>
<a name="getMemberServerSession-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMemberServerSession</h4>
<pre><a href="../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a>&nbsp;getMemberServerSession(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;cls)</pre>
<div class="block">Return the member ServerSession that maps cls in session broker.
Return null if either not a session broker or cls is not mapped.
Session broker implement composite persistence unit.</div>
</li>
</ul>
<a name="getMemberSessionName-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMemberSessionName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getMemberSessionName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;cls)</pre>
<div class="block">Return the name of member session that maps cls.
Return null if either not a session broker or cls is not mapped.
Session broker implement composite persistence unit.</div>
</li>
</ul>
<a name="isBroker--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBroker</h4>
<pre>boolean&nbsp;isBroker()</pre>
<div class="block">Indicates whether the underlying session is a session broker.
Session broker implement composite persistence unit.</div>
</li>
</ul>
<a name="getUnitOfWork--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnitOfWork</h4>
<pre><a href="../../../../org/eclipse/persistence/sessions/UnitOfWork.html" title="interface in org.eclipse.persistence.sessions">UnitOfWork</a>&nbsp;getUnitOfWork()</pre>
<div class="block">This method will return the transactional UnitOfWork during the transaction and null
outside of the transaction.</div>
</li>
</ul>
<a name="getSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSession</h4>
<pre><a href="../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a>&nbsp;getSession()</pre>
<div class="block">This method will return a Session outside of a transaction and null within a transaction.</div>
</li>
</ul>
<a name="createQuery-org.eclipse.persistence.expressions.Expression-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createQuery</h4>
<pre>jakarta.persistence.Query&nbsp;createQuery(<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&nbsp;expression,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;entityClass)</pre>
<div class="block">This method is used to create a query using a EclipseLink Expression for the entity class.</div>
</li>
</ul>
<a name="createQuery-org.eclipse.persistence.queries.DatabaseQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createQuery</h4>
<pre>jakarta.persistence.Query&nbsp;createQuery(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a>&nbsp;query)</pre>
<div class="block">This method is used to create a query using a EclipseLink DatabaseQuery.</div>
</li>
</ul>
<a name="createQuery-org.eclipse.persistence.queries.Call-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createQuery</h4>
<pre>jakarta.persistence.Query&nbsp;createQuery(<a href="../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a>&nbsp;call)</pre>
<div class="block">This method is used to create a query using a EclipseLink Call.</div>
</li>
</ul>
<a name="createQuery-org.eclipse.persistence.queries.Call-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createQuery</h4>
<pre>jakarta.persistence.Query&nbsp;createQuery(<a href="../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a>&nbsp;call,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;entityClass)</pre>
<div class="block">This method is used to create a query using a EclipseLink Call for the entity class.</div>
</li>
</ul>
<a name="createQueryByExample-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createQueryByExample</h4>
<pre>jakarta.persistence.Query&nbsp;createQueryByExample(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;exampleObject)</pre>
<div class="block">This method is used to create a query using query by example.</div>
</li>
</ul>
<a name="createDescriptorNamedQuery-java.lang.String-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDescriptorNamedQuery</h4>
<pre>jakarta.persistence.Query&nbsp;createDescriptorNamedQuery(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queryName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;descriptorClass)</pre>
<div class="block">This method will create a query object that wraps a EclipseLink Named Query.</div>
</li>
</ul>
<a name="createDescriptorNamedQuery-java.lang.String-java.lang.Class-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDescriptorNamedQuery</h4>
<pre>jakarta.persistence.Query&nbsp;createDescriptorNamedQuery(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queryName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;descriptorClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&nbsp;argumentTypes)</pre>
<div class="block">This method will create a query object that wraps a EclipseLink Named Query.</div>
</li>
</ul>
<a name="load-java.lang.Object-org.eclipse.persistence.queries.AttributeGroup-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>load</h4>
<pre>void&nbsp;load(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;entityOrEntities,
<a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html" title="class in org.eclipse.persistence.queries">AttributeGroup</a>&nbsp;group)</pre>
<div class="block">This method will load the passed entity or collection of entities using the passed AttributeGroup.
In case of collection all members should be either entities of the same type
or have a common inheritance hierarchy mapped root class.
The AttributeGroup should correspond to the entity type.</div>
</li>
</ul>
<a name="copy-java.lang.Object-org.eclipse.persistence.queries.AttributeGroup-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>copy</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;copy(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;entityOrEntities,
<a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html" title="class in org.eclipse.persistence.queries">AttributeGroup</a>&nbsp;group)</pre>
<div class="block">This method will return copy the passed entity using the passed AttributeGroup.
In case of collection all members should be either entities of the same type
or have a common inheritance hierarchy mapped root class.
The AttributeGroup should correspond to the entity type.</div>
</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 class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/persistence/jpa/JpaCriteriaBuilder.html" title="interface in org.eclipse.persistence.jpa"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/persistence/jpa/JpaEntityManagerFactory.html" title="interface in org.eclipse.persistence.jpa"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/persistence/jpa/JpaEntityManager.html" target="_top">Frames</a></li>
<li><a href="JpaEntityManager.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>