| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>PersistenceManager (JDO API 3.2.1)</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="PersistenceManager (JDO API 3.2.1)"; |
| } |
| } |
| 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,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6,"i54":6,"i55":6,"i56":6,"i57":6,"i58":6,"i59":6,"i60":6,"i61":6,"i62":6,"i63":6,"i64":6,"i65":6,"i66":6,"i67":6,"i68":6,"i69":6,"i70":6,"i71":6,"i72":6,"i73":6,"i74":6,"i75":6,"i76":6,"i77":6,"i78":6,"i79":6,"i80":6,"i81":6,"i82":6,"i83":6,"i84":6,"i85":6,"i86":6,"i87":6,"i88":6,"i89":6,"i90":6,"i91":6,"i92":6,"i93":6,"i94":6,"i95":6,"i96":6,"i97":6,"i98":6,"i99":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="class-use/PersistenceManager.html">Use</a></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="../../javax/jdo/ObjectState.html" title="enum in javax.jdo"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../javax/jdo/PersistenceManagerFactory.html" title="interface in javax.jdo"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?javax/jdo/PersistenceManager.html" target="_top">Frames</a></li> |
| <li><a href="PersistenceManager.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">javax.jdo</div> |
| <h2 title="Interface PersistenceManager" class="title">Interface PersistenceManager</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></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">PersistenceManager</span> |
| extends <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"><code>PersistenceManager</code> is the primary interface for JDO-aware |
| application components. It is the factory for <code>Query</code> and |
| <code>Transaction</code> instances, and contains methods to manage the |
| life cycle of <code>PersistenceCapable</code> instances. |
| |
| <P>A <code>PersistenceManager</code> is obtained from the |
| <a href="../../javax/jdo/PersistenceManagerFactory.html" title="interface in javax.jdo"><code>PersistenceManagerFactory</code></a> |
| (recommended) or by construction.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>2.1</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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#addInstanceLifecycleListener-javax.jdo.listener.InstanceLifecycleListener-java.lang.Class...-">addInstanceLifecycleListener</a></span>(<a href="../../javax/jdo/listener/InstanceLifecycleListener.html" title="interface in javax.jdo.listener">InstanceLifecycleListener</a> listener, |
| <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>... classes)</code> |
| <div class="block">Adds the listener instance to the list of lifecycle event |
| listeners.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#checkConsistency--">checkConsistency</a></span>()</code> |
| <div class="block">Validates the <code>PersistenceManager</code> cache with the |
| datastore.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#close--">close</a></span>()</code> |
| <div class="block">Close this <code>PersistenceManager</code> so that no further requests |
| may be made on it.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/Transaction.html" title="interface in javax.jdo">Transaction</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#currentTransaction--">currentTransaction</a></span>()</code> |
| <div class="block">Return the <code>Transaction</code> instance associated with a |
| <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#deletePersistent-java.lang.Object-">deletePersistent</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> pc)</code> |
| <div class="block">Delete the persistent instance from the data store.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#deletePersistentAll-java.util.Collection-">deletePersistentAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs)</code> |
| <div class="block">Delete a <code>Collection</code> of instances from the data store.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#deletePersistentAll-java.lang.Object...-">deletePersistentAll</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>... pcs)</code> |
| <div class="block">Delete an array of instances from the data store.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#detachCopy-T-">detachCopy</a></span>(T pc)</code> |
| <div class="block">Detach the specified instance from the <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><T> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#detachCopyAll-java.util.Collection-">detachCopyAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><T> pcs)</code> |
| <div class="block">Detach the specified instances from the <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><T> T[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#detachCopyAll-T...-">detachCopyAll</a></span>(T... pcs)</code> |
| <div class="block">Detach the specified instances from the <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#evict-java.lang.Object-">evict</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> pc)</code> |
| <div class="block">Mark an instance as no longer needed in the cache.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#evictAll--">evictAll</a></span>()</code> |
| <div class="block">Mark all persistent-nontransactional instances as no longer needed |
| in the cache.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#evictAll-boolean-java.lang.Class-">evictAll</a></span>(boolean subclasses, |
| <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> pcClass)</code> |
| <div class="block">Mark the parameter instances as no longer needed in the cache.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#evictAll-java.util.Collection-">evictAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs)</code> |
| <div class="block">Mark a <code>Collection</code> of instances as no longer needed in the |
| cache.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#evictAll-java.lang.Object...-">evictAll</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>... pcs)</code> |
| <div class="block">Mark an array of instances as no longer needed in the cache.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#flush--">flush</a></span>()</code> |
| <div class="block">Flushes all dirty, new, and deleted instances to the data |
| store.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getCopyOnAttach--">getCopyOnAttach</a></span>()</code> |
| <div class="block">Gets the copyOnAttach setting.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/datastore/JDOConnection.html" title="interface in javax.jdo.datastore">JDOConnection</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getDataStoreConnection--">getDataStoreConnection</a></span>()</code> |
| <div class="block">If this method is called while a datastore transaction is |
| active, the object returned will be enlisted in the current |
| transaction.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getDatastoreReadTimeoutMillis--">getDatastoreReadTimeoutMillis</a></span>()</code> |
| <div class="block">Get the effective timeout setting for datastore read operations |
| associated with this persistence manager.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getDatastoreWriteTimeoutMillis--">getDatastoreWriteTimeoutMillis</a></span>()</code> |
| <div class="block">Get the effective timeout setting for write operations.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getDetachAllOnCommit--">getDetachAllOnCommit</a></span>()</code> |
| <div class="block">Gets the detachAllOnCommit setting.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><T> <a href="../../javax/jdo/Extent.html" title="interface in javax.jdo">Extent</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getExtent-java.lang.Class-">getExtent</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><T> persistenceCapableClass)</code> |
| <div class="block">Equivalent to <code>getExtent (persistenceCapableClass, true)</code>.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../javax/jdo/Extent.html" title="interface in javax.jdo">Extent</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getExtent-java.lang.Class-boolean-">getExtent</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><T> persistenceCapableClass, |
| boolean subclasses)</code> |
| <div class="block">The <code>PersistenceManager</code> manages a collection of instances in |
| the data store based on the class of the instances.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getFetchGroup-java.lang.Class-java.lang.String-">getFetchGroup</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> cls, |
| <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> name)</code> |
| <div class="block">Get a modifiable <code>FetchGroup</code> for the Class and name.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getFetchPlan--">getFetchPlan</a></span>()</code> |
| <div class="block">Returns the <code>FetchPlan</code> used by this |
| <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getIgnoreCache--">getIgnoreCache</a></span>()</code> |
| <div class="block">Get the ignoreCache setting for queries.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getManagedObjects--">getManagedObjects</a></span>()</code> |
| <div class="block">Get the objects managed by this persistence manager.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getManagedObjects-java.lang.Class...-">getManagedObjects</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>... classes)</code> |
| <div class="block">Get the objects managed by this persistence manager being instances of |
| the specified classes.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getManagedObjects-java.util.EnumSet-">getManagedObjects</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../javax/jdo/ObjectState.html" title="enum in javax.jdo">ObjectState</a>> states)</code> |
| <div class="block">Get the objects managed by this persistence manager having the |
| specified object states.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getManagedObjects-java.util.EnumSet-java.lang.Class...-">getManagedObjects</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../javax/jdo/ObjectState.html" title="enum in javax.jdo">ObjectState</a>> states, |
| <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>... classes)</code> |
| <div class="block">Get the objects managed by this persistence manager having the |
| specified object states and being instances of the specified classes.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getMultithreaded--">getMultithreaded</a></span>()</code> |
| <div class="block">Get the current Multithreaded flag for this |
| <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getObjectById-java.lang.Class-java.lang.Object-">getObjectById</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><T> cls, |
| <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> key)</code> |
| <div class="block">Looks up the instance of the given type with the given key.</div> |
| </td> |
| </tr> |
| <tr id="i32" 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="../../javax/jdo/PersistenceManager.html#getObjectById-java.lang.Object-">getObjectById</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> oid)</code> |
| <div class="block">Looks up the instance corresponding to the specified oid.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <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="../../javax/jdo/PersistenceManager.html#getObjectById-java.lang.Object-boolean-">getObjectById</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> oid, |
| boolean validate)</code> |
| <div class="block">This method locates a persistent instance in the cache of instances |
| managed by this <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i34" 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="../../javax/jdo/PersistenceManager.html#getObjectId-java.lang.Object-">getObjectId</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> pc)</code> |
| <div class="block">The ObjectId returned by this method represents the JDO identity of |
| the instance.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getObjectIdClass-java.lang.Class-">getObjectIdClass</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> cls)</code> |
| <div class="block">Return the <code>Class</code> that implements the JDO Identity for the |
| specified <code>PersistenceCapable</code> class.</div> |
| </td> |
| </tr> |
| <tr id="i36" 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="../../javax/jdo/PersistenceManager.html#getObjectsById-boolean-java.lang.Object...-">getObjectsById</a></span>(boolean validate, |
| <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>... oids)</code> |
| <div class="block">Return the objects with the given oids.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getObjectsById-java.util.Collection-">getObjectsById</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> oids)</code> |
| <div class="block">Return the objects with the given oids.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getObjectsById-java.util.Collection-boolean-">getObjectsById</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> oids, |
| boolean validate)</code> |
| <div class="block">Return the objects with the given oids.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <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="../../javax/jdo/PersistenceManager.html#getObjectsById-java.lang.Object...-">getObjectsById</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>... oids)</code> |
| <div class="block">Return the objects with the given oids.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/PersistenceManagerFactory.html" title="interface in javax.jdo">PersistenceManagerFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getPersistenceManagerFactory--">getPersistenceManagerFactory</a></span>()</code> |
| <div class="block">This method returns the <code>PersistenceManagerFactory</code> used to |
| create this <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,<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="../../javax/jdo/PersistenceManager.html#getProperties--">getProperties</a></span>()</code> |
| <div class="block">Get the properties and associated values currently in effect for the |
| persistence manager.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/datastore/Sequence.html" title="interface in javax.jdo.datastore">Sequence</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getSequence-java.lang.String-">getSequence</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> name)</code> |
| <div class="block">Returns the sequence identified by <code>name</code>.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#getServerDate--">getServerDate</a></span>()</code> |
| <div class="block">Get the Date as seen by the server.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<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="../../javax/jdo/PersistenceManager.html#getSupportedProperties--">getSupportedProperties</a></span>()</code> |
| <div class="block">Get the names of the properties that are supported for use with the |
| persistence manager.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <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="../../javax/jdo/PersistenceManager.html#getTransactionalObjectId-java.lang.Object-">getTransactionalObjectId</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> pc)</code> |
| <div class="block">The ObjectId returned by this method represents the JDO identity of |
| the instance.</div> |
| </td> |
| </tr> |
| <tr id="i46" 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="../../javax/jdo/PersistenceManager.html#getUserObject--">getUserObject</a></span>()</code> |
| <div class="block">The application can manage the <code>PersistenceManager</code> instances |
| more easily by having an application object associated with each |
| <code>PersistenceManager</code> instance.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <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="../../javax/jdo/PersistenceManager.html#getUserObject-java.lang.Object-">getUserObject</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> key)</code> |
| <div class="block">Get the value for the specified key from the map of user objects.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#isClosed--">isClosed</a></span>()</code> |
| <div class="block">A <code>PersistenceManager</code> instance can be used until it is |
| closed.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#makeNontransactional-java.lang.Object-">makeNontransactional</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> pc)</code> |
| <div class="block">Make an instance non-transactional after commit.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#makeNontransactionalAll-java.util.Collection-">makeNontransactionalAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs)</code> |
| <div class="block">Make a <code>Collection</code> of instances non-transactional after |
| commit.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#makeNontransactionalAll-java.lang.Object...-">makeNontransactionalAll</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>... pcs)</code> |
| <div class="block">Make an array of instances non-transactional after commit.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#makePersistent-T-">makePersistent</a></span>(T pc)</code> |
| <div class="block">Make the parameter instance persistent in this |
| <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code><T> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#makePersistentAll-java.util.Collection-">makePersistentAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><T> pcs)</code> |
| <div class="block">Make a <code>Collection</code> of instances persistent.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code><T> T[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#makePersistentAll-T...-">makePersistentAll</a></span>(T... pcs)</code> |
| <div class="block">Make an array of instances persistent.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#makeTransactional-java.lang.Object-">makeTransactional</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> pc)</code> |
| <div class="block">Make an instance subject to transactional boundaries.</div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#makeTransactionalAll-java.util.Collection-">makeTransactionalAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs)</code> |
| <div class="block">Make a <code>Collection</code> of instances subject to transactional |
| boundaries.</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#makeTransactionalAll-java.lang.Object...-">makeTransactionalAll</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>... pcs)</code> |
| <div class="block">Make an array of instances subject to transactional boundaries.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#makeTransient-java.lang.Object-">makeTransient</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> pc)</code> |
| <div class="block">Make an instance transient, removing it from management by this |
| <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#makeTransient-java.lang.Object-boolean-">makeTransient</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> pc, |
| boolean useFetchPlan)</code> |
| <div class="block">Make an instance transient, removing it from management by this |
| <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#makeTransientAll-boolean-java.lang.Object...-">makeTransientAll</a></span>(boolean useFetchPlan, |
| <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>... pcs)</code> |
| <div class="block">Make instances transient, removing them from management |
| by this <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#makeTransientAll-java.util.Collection-">makeTransientAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs)</code> |
| <div class="block">Make a <code>Collection</code> of instances transient, removing them |
| from management by this <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#makeTransientAll-java.util.Collection-boolean-">makeTransientAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs, |
| boolean useFetchPlan)</code> |
| <div class="block">Make instances transient, removing them from management |
| by this <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#makeTransientAll-java.lang.Object...-">makeTransientAll</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>... pcs)</code> |
| <div class="block">Make an array of instances transient, removing them from management by |
| this <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#newInstance-java.lang.Class-">newInstance</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><T> pcClass)</code> |
| <div class="block">Creates an instance of a persistence-capable interface, |
| or of a concrete or abstract class.</div> |
| </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><code><T> <a href="../../javax/jdo/JDOQLTypedQuery.html" title="interface in javax.jdo">JDOQLTypedQuery</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#newJDOQLTypedQuery-java.lang.Class-">newJDOQLTypedQuery</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><T> cls)</code> |
| <div class="block">Create a new <code>JDOQLTypedQuery</code> with the specified candidate class.</div> |
| </td> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#newNamedQuery-java.lang.Class-java.lang.String-">newNamedQuery</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><T> cls, |
| <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> queryName)</code> |
| <div class="block">Create a new <code>Query</code> with the given candidate class |
| from a named query.</div> |
| </td> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <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="../../javax/jdo/PersistenceManager.html#newObjectIdInstance-java.lang.Class-java.lang.Object-">newObjectIdInstance</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> pcClass, |
| <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> key)</code> |
| <div class="block">This method returns an object id instance corresponding to the pcClass |
| and key arguments.</div> |
| </td> |
| </tr> |
| <tr id="i68" class="altColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#newQuery--">newQuery</a></span>()</code> |
| <div class="block">Create a new <code>Query</code> with no elements.</div> |
| </td> |
| </tr> |
| <tr id="i69" class="rowColor"> |
| <td class="colFirst"><code><T> <a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#newQuery-java.lang.Class-">newQuery</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><T> cls)</code> |
| <div class="block">Create a new <code>Query</code> specifying the <code>Class</code> of the |
| candidate instances.</div> |
| </td> |
| </tr> |
| <tr id="i70" class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#newQuery-java.lang.Class-java.util.Collection-">newQuery</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><T> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><T> cln)</code> |
| <div class="block">Create a new <code>Query</code> with the candidate <code>Class</code> |
| and <code>Collection</code>.</div> |
| </td> |
| </tr> |
| <tr id="i71" class="rowColor"> |
| <td class="colFirst"><code><T> <a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#newQuery-java.lang.Class-java.util.Collection-java.lang.String-">newQuery</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><T> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><T> cln, |
| <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> filter)</code> |
| <div class="block">Create a new <code>Query</code> with the <code>Class</code> of the candidate instances, |
| candidate <code>Collection</code>, and filter.</div> |
| </td> |
| </tr> |
| <tr id="i72" class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#newQuery-java.lang.Class-java.lang.String-">newQuery</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><T> cls, |
| <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> filter)</code> |
| <div class="block">Create a new <code>Query</code> with the <code>Class</code> of the |
| candidate instances and filter.</div> |
| </td> |
| </tr> |
| <tr id="i73" class="rowColor"> |
| <td class="colFirst"><code><T> <a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#newQuery-javax.jdo.Extent-">newQuery</a></span>(<a href="../../javax/jdo/Extent.html" title="interface in javax.jdo">Extent</a><T> cln)</code> |
| <div class="block">Create a new <code>Query</code> with the <code>Class</code> of the |
| candidate instances and candidate <code>Extent</code>.</div> |
| </td> |
| </tr> |
| <tr id="i74" class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#newQuery-javax.jdo.Extent-java.lang.String-">newQuery</a></span>(<a href="../../javax/jdo/Extent.html" title="interface in javax.jdo">Extent</a><T> cln, |
| <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> filter)</code> |
| <div class="block">Create a new <code>Query</code> with the |
| candidate <code>Extent</code> and filter; the class |
| is taken from the <code>Extent</code>.</div> |
| </td> |
| </tr> |
| <tr id="i75" class="rowColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#newQuery-java.lang.Object-">newQuery</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> compiled)</code> |
| <div class="block">Create a new <code>Query</code> using elements from another |
| <code>Query</code>.</div> |
| </td> |
| </tr> |
| <tr id="i76" class="altColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#newQuery-java.lang.String-">newQuery</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> query)</code> |
| <div class="block">Create a Construct a new query instance using the specified String |
| as the single-string representation of the query.</div> |
| </td> |
| </tr> |
| <tr id="i77" class="rowColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#newQuery-java.lang.String-java.lang.Object-">newQuery</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> language, |
| <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> query)</code> |
| <div class="block">Create a new <code>Query</code> using the specified language.</div> |
| </td> |
| </tr> |
| <tr id="i78" 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="../../javax/jdo/PersistenceManager.html#putUserObject-java.lang.Object-java.lang.Object-">putUserObject</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> key, |
| <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> val)</code> |
| <div class="block">Put the specified key-value pair into the map of user objects.</div> |
| </td> |
| </tr> |
| <tr id="i79" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#refresh-java.lang.Object-">refresh</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> pc)</code> |
| <div class="block">Refresh the state of the instance from the data store.</div> |
| </td> |
| </tr> |
| <tr id="i80" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#refreshAll--">refreshAll</a></span>()</code> |
| <div class="block">Refresh the state of all applicable instances from the data store.</div> |
| </td> |
| </tr> |
| <tr id="i81" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#refreshAll-java.util.Collection-">refreshAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs)</code> |
| <div class="block">Refresh the state of a <code>Collection</code> of instances from the |
| data store.</div> |
| </td> |
| </tr> |
| <tr id="i82" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#refreshAll-javax.jdo.JDOException-">refreshAll</a></span>(<a href="../../javax/jdo/JDOException.html" title="class in javax.jdo">JDOException</a> jdoe)</code> |
| <div class="block">Refreshes all instances in the exception that failed verification.</div> |
| </td> |
| </tr> |
| <tr id="i83" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#refreshAll-java.lang.Object...-">refreshAll</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>... pcs)</code> |
| <div class="block">Refresh the state of an array of instances from the data store.</div> |
| </td> |
| </tr> |
| <tr id="i84" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#removeInstanceLifecycleListener-javax.jdo.listener.InstanceLifecycleListener-">removeInstanceLifecycleListener</a></span>(<a href="../../javax/jdo/listener/InstanceLifecycleListener.html" title="interface in javax.jdo.listener">InstanceLifecycleListener</a> listener)</code> |
| <div class="block">Removes the listener instance from the list of lifecycle event listeners.</div> |
| </td> |
| </tr> |
| <tr id="i85" class="rowColor"> |
| <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="../../javax/jdo/PersistenceManager.html#removeUserObject-java.lang.Object-">removeUserObject</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> key)</code> |
| <div class="block">Remove the specified key and its value from the map of user objects.</div> |
| </td> |
| </tr> |
| <tr id="i86" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#retrieve-java.lang.Object-">retrieve</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> pc)</code> |
| <div class="block">Retrieve field values of an instance from the store.</div> |
| </td> |
| </tr> |
| <tr id="i87" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#retrieve-java.lang.Object-boolean-">retrieve</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> pc, |
| boolean useFetchPlan)</code> |
| <div class="block">Retrieve field values of an instance from the store.</div> |
| </td> |
| </tr> |
| <tr id="i88" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#retrieveAll-boolean-java.lang.Object...-">retrieveAll</a></span>(boolean useFetchPlan, |
| <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>... pcs)</code> |
| <div class="block">Retrieve field values of instances from the store.</div> |
| </td> |
| </tr> |
| <tr id="i89" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#retrieveAll-java.util.Collection-">retrieveAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs)</code> |
| <div class="block">Retrieve field values of instances from the store.</div> |
| </td> |
| </tr> |
| <tr id="i90" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#retrieveAll-java.util.Collection-boolean-">retrieveAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs, |
| boolean useFetchPlan)</code> |
| <div class="block">Retrieve field values of instances from the store.</div> |
| </td> |
| </tr> |
| <tr id="i91" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#retrieveAll-java.lang.Object...-">retrieveAll</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>... pcs)</code> |
| <div class="block">Retrieve field values of instances from the store.</div> |
| </td> |
| </tr> |
| <tr id="i92" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#setCopyOnAttach-boolean-">setCopyOnAttach</a></span>(boolean flag)</code> |
| <div class="block">Sets the copyOnAttach setting.</div> |
| </td> |
| </tr> |
| <tr id="i93" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#setDatastoreReadTimeoutMillis-java.lang.Integer-">setDatastoreReadTimeoutMillis</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> interval)</code> |
| <div class="block">Specify a timeout interval (milliseconds) for any datastore read |
| operations associated with this persistence manager.</div> |
| </td> |
| </tr> |
| <tr id="i94" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#setDatastoreWriteTimeoutMillis-java.lang.Integer-">setDatastoreWriteTimeoutMillis</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> interval)</code> |
| <div class="block">Specify a timeout interval (milliseconds) for any write operations |
| associated with this persistence manager.</div> |
| </td> |
| </tr> |
| <tr id="i95" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#setDetachAllOnCommit-boolean-">setDetachAllOnCommit</a></span>(boolean flag)</code> |
| <div class="block">Sets the detachAllOnCommit setting.</div> |
| </td> |
| </tr> |
| <tr id="i96" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#setIgnoreCache-boolean-">setIgnoreCache</a></span>(boolean flag)</code> |
| <div class="block">Set the ignoreCache parameter for queries.</div> |
| </td> |
| </tr> |
| <tr id="i97" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#setMultithreaded-boolean-">setMultithreaded</a></span>(boolean flag)</code> |
| <div class="block">Set the Multithreaded flag for this <code>PersistenceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i98" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#setProperty-java.lang.String-java.lang.Object-">setProperty</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> propertyName, |
| <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> value)</code> |
| <div class="block">Set a persistence manager property.</div> |
| </td> |
| </tr> |
| <tr id="i99" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/PersistenceManager.html#setUserObject-java.lang.Object-">setUserObject</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> o)</code> |
| <div class="block">The application can manage the <code>PersistenceManager</code> instances |
| more easily by having an application object associated with each |
| <code>PersistenceManager</code> instance.</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="isClosed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isClosed</h4> |
| <pre>boolean isClosed()</pre> |
| <div class="block">A <code>PersistenceManager</code> instance can be used until it is |
| closed.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if this <code>PersistenceManager</code> has |
| been closed.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#close--"><code>close()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <div class="block">Close this <code>PersistenceManager</code> so that no further requests |
| may be made on it. A <code>PersistenceManager</code> instance can be |
| used only until it is closed. |
| |
| <P>Closing a <code>PersistenceManager</code> might release it to the pool |
| of available <code>PersistenceManager</code>s, or might be garbage |
| collected, at the option of the JDO implementation. Before being used |
| again to satisfy a <code>getPersistenceManager()</code> request, the |
| default values for options will be restored to their values as specified |
| in the <code>PersistenceManagerFactory</code>. |
| |
| <P>This method closes the <code>PersistenceManager</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><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> in interface <code><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></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="currentTransaction--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>currentTransaction</h4> |
| <pre><a href="../../javax/jdo/Transaction.html" title="interface in javax.jdo">Transaction</a> currentTransaction()</pre> |
| <div class="block">Return the <code>Transaction</code> instance associated with a |
| <code>PersistenceManager</code>. There is one <code>Transaction</code> |
| instance associated with each <code>PersistenceManager</code> instance. |
| The <code>Transaction</code> instance supports options as well as |
| transaction completion requests.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Transaction</code> associated with this |
| <code>PersistenceManager</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="evict-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>evict</h4> |
| <pre>void evict(<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> pc)</pre> |
| <div class="block">Mark an instance as no longer needed in the cache. Eviction is normally |
| done automatically by the <code>PersistenceManager</code> at transaction |
| completion. This method allows the application to explicitly provide a |
| hint to the <code>PersistenceManager</code> that the instance is no |
| longer needed in the cache.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pc</code> - the instance to evict from the cache.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="evictAll-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>evictAll</h4> |
| <pre>void evictAll(<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>... pcs)</pre> |
| <div class="block">Mark an array of instances as no longer needed in the cache.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the array of instances to evict from the cache.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#evict-java.lang.Object-"><code>evict(Object pc)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="evictAll-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>evictAll</h4> |
| <pre>void evictAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs)</pre> |
| <div class="block">Mark a <code>Collection</code> of instances as no longer needed in the |
| cache.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the <code>Collection</code> of instances to evict from the |
| cache.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#evict-java.lang.Object-"><code>evict(Object pc)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="evictAll-boolean-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>evictAll</h4> |
| <pre>void evictAll(boolean subclasses, |
| <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> pcClass)</pre> |
| <div class="block">Mark the parameter instances as no longer needed in the cache.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcClass</code> - the class of instances to evict</dd> |
| <dd><code>subclasses</code> - if true, mark instances of subclasses also</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="evictAll--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>evictAll</h4> |
| <pre>void evictAll()</pre> |
| <div class="block">Mark all persistent-nontransactional instances as no longer needed |
| in the cache. It transitions |
| all persistent-nontransactional instances to hollow. Transactional |
| instances are subject to eviction based on the RetainValues setting.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#evict-java.lang.Object-"><code>evict(Object pc)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="refresh-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refresh</h4> |
| <pre>void refresh(<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> pc)</pre> |
| <div class="block">Refresh the state of the instance from the data store. |
| |
| <P>In an optimistic transaction, the state of instances in the cache |
| might not match the state in the data store. This method is used to |
| reload the state of the instance from the data store so that a subsequent |
| commit is more likely to succeed. |
| <P>Outside a transaction, this method will refresh nontransactional |
| state.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pc</code> - the instance to refresh.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="refreshAll-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refreshAll</h4> |
| <pre>void refreshAll(<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>... pcs)</pre> |
| <div class="block">Refresh the state of an array of instances from the data store.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the array of instances to refresh.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#refresh-java.lang.Object-"><code>refresh(Object pc)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="refreshAll-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refreshAll</h4> |
| <pre>void refreshAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs)</pre> |
| <div class="block">Refresh the state of a <code>Collection</code> of instances from the |
| data store.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the <code>Collection</code> of instances to refresh.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#refresh-java.lang.Object-"><code>refresh(Object pc)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="refreshAll--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refreshAll</h4> |
| <pre>void refreshAll()</pre> |
| <div class="block">Refresh the state of all applicable instances from the data store. |
| <P>If called with an active transaction, all transactional instances |
| will be refreshed. If called outside an active transaction, all |
| nontransactional instances will be refreshed.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#refresh-java.lang.Object-"><code>refresh(Object pc)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="refreshAll-javax.jdo.JDOException-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refreshAll</h4> |
| <pre>void refreshAll(<a href="../../javax/jdo/JDOException.html" title="class in javax.jdo">JDOException</a> jdoe)</pre> |
| <div class="block">Refreshes all instances in the exception that failed verification.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jdoe</code> - The exception defining object(s) to be refreshed</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newQuery</h4> |
| <pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a> newQuery()</pre> |
| <div class="block">Create a new <code>Query</code> with no elements.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>Query</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newQuery-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newQuery</h4> |
| <pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a> newQuery(<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> compiled)</pre> |
| <div class="block">Create a new <code>Query</code> using elements from another |
| <code>Query</code>. The other <code>Query</code> must have been created |
| by the same JDO implementation. It might be active in a different |
| <code>PersistenceManager</code> or might have been serialized and |
| restored. |
| <P>All of the settings of the other <code>Query</code> are copied to this |
| <code>Query</code>, except for the candidate <code>Collection</code> or |
| <code>Extent</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>compiled</code> - another <code>Query</code> from the same JDO implementation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>Query</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newQuery-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newQuery</h4> |
| <pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a> newQuery(<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> query)</pre> |
| <div class="block">Create a Construct a new query instance using the specified String |
| as the single-string representation of the query.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>query</code> - the single-string query</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>Query</code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newQuery-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newQuery</h4> |
| <pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a> newQuery(<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> language, |
| <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> query)</pre> |
| <div class="block">Create a new <code>Query</code> using the specified language.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>language</code> - the language of the query parameter</dd> |
| <dd><code>query</code> - the query, which is of a form determined by the language</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>Query</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newQuery-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newQuery</h4> |
| <pre><T> <a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a><T> newQuery(<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><T> cls)</pre> |
| <div class="block">Create a new <code>Query</code> specifying the <code>Class</code> of the |
| candidate instances.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Candidate type for the query</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cls</code> - the <code>Class</code> of the candidate instances</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>Query</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newQuery-javax.jdo.Extent-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newQuery</h4> |
| <pre><T> <a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a><T> newQuery(<a href="../../javax/jdo/Extent.html" title="interface in javax.jdo">Extent</a><T> cln)</pre> |
| <div class="block">Create a new <code>Query</code> with the <code>Class</code> of the |
| candidate instances and candidate <code>Extent</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Candidate type for the query</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cln</code> - the <code>Extent</code> of candidate instances</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>Query</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newQuery-java.lang.Class-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newQuery</h4> |
| <pre><T> <a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a><T> newQuery(<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><T> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><T> cln)</pre> |
| <div class="block">Create a new <code>Query</code> with the candidate <code>Class</code> |
| and <code>Collection</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Candidate type for the query</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cls</code> - the <code>Class</code> of results</dd> |
| <dd><code>cln</code> - the <code>Collection</code> of candidate instances</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>Query</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newQuery-java.lang.Class-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newQuery</h4> |
| <pre><T> <a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a><T> newQuery(<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><T> cls, |
| <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> filter)</pre> |
| <div class="block">Create a new <code>Query</code> with the <code>Class</code> of the |
| candidate instances and filter.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Candidate type for the query</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cls</code> - the <code>Class</code> of results</dd> |
| <dd><code>filter</code> - the filter for candidate instances</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>Query</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newQuery-java.lang.Class-java.util.Collection-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newQuery</h4> |
| <pre><T> <a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a><T> newQuery(<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><T> cls, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><T> cln, |
| <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> filter)</pre> |
| <div class="block">Create a new <code>Query</code> with the <code>Class</code> of the candidate instances, |
| candidate <code>Collection</code>, and filter.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Candidate type for the query</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cls</code> - the <code>Class</code> of candidate instances</dd> |
| <dd><code>cln</code> - the <code>Collection</code> of candidate instances</dd> |
| <dd><code>filter</code> - the filter for candidate instances</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>Query</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newQuery-javax.jdo.Extent-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newQuery</h4> |
| <pre><T> <a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a><T> newQuery(<a href="../../javax/jdo/Extent.html" title="interface in javax.jdo">Extent</a><T> cln, |
| <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> filter)</pre> |
| <div class="block">Create a new <code>Query</code> with the |
| candidate <code>Extent</code> and filter; the class |
| is taken from the <code>Extent</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Candidate type for the query</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cln</code> - the <code>Extent</code> of candidate instances</dd> |
| <dd><code>filter</code> - the filter for candidate instances</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>Query</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newJDOQLTypedQuery-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newJDOQLTypedQuery</h4> |
| <pre><T> <a href="../../javax/jdo/JDOQLTypedQuery.html" title="interface in javax.jdo">JDOQLTypedQuery</a><T> newJDOQLTypedQuery(<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><T> cls)</pre> |
| <div class="block">Create a new <code>JDOQLTypedQuery</code> with the specified candidate class.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Candidate type for the query</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cls</code> - Candidate class for the query</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The JDOQLTypedQuery</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newNamedQuery-java.lang.Class-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newNamedQuery</h4> |
| <pre><T> <a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a><T> newNamedQuery(<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><T> cls, |
| <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> queryName)</pre> |
| <div class="block">Create a new <code>Query</code> with the given candidate class |
| from a named query. The query name given must be the name of a |
| query defined in metadata.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Candidate type for the query</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cls</code> - the <code>Class</code> of candidate instances</dd> |
| <dd><code>queryName</code> - the name of the query to look up in metadata</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>Query</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExtent-java.lang.Class-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtent</h4> |
| <pre><T> <a href="../../javax/jdo/Extent.html" title="interface in javax.jdo">Extent</a><T> getExtent(<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><T> persistenceCapableClass, |
| boolean subclasses)</pre> |
| <div class="block">The <code>PersistenceManager</code> manages a collection of instances in |
| the data store based on the class of the instances. This method returns |
| an <code>Extent</code> of instances in the data store that might be |
| iterated or given to a <code>Query</code>. The <code>Extent</code> |
| itself might not reference any instances, but only hold the class name |
| and an indicator as to whether subclasses are included in the |
| <code>Extent</code>. |
| <P>Note that the <code>Extent</code> might be very large.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type for the candidate of the Extent</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>persistenceCapableClass</code> - <code>Class</code> of instances</dd> |
| <dd><code>subclasses</code> - whether to include instances of subclasses</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <code>Extent</code> of the specified <code>Class</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/Query.html" title="interface in javax.jdo"><code>Query</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExtent-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtent</h4> |
| <pre><T> <a href="../../javax/jdo/Extent.html" title="interface in javax.jdo">Extent</a><T> getExtent(<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><T> persistenceCapableClass)</pre> |
| <div class="block">Equivalent to <code>getExtent (persistenceCapableClass, true)</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type for the candidate of the Extent</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>persistenceCapableClass</code> - Candidate class for the extent</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <code>Extent</code> of the specified <code>Class</code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#getExtent-java.lang.Class-boolean-"><code>getExtent(Class,boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getObjectById-java.lang.Object-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectById</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> getObjectById(<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> oid, |
| boolean validate)</pre> |
| <div class="block">This method locates a persistent instance in the cache of instances |
| managed by this <code>PersistenceManager</code>. |
| The <code>getObjectById</code> method attempts |
| to find an instance in the cache with the specified JDO identity. |
| The <code>oid</code> parameter object might have been returned by an |
| earlier call to <code>getObjectId</code> or |
| <code>getTransactionalObjectId</code>, or might have been constructed by |
| the application. |
| <P>If the <code>PersistenceManager</code> is unable to resolve the |
| <code>oid</code> parameter to an ObjectId instance, then it throws a |
| <code>JDOUserException</code>. |
| <P>If the <code>validate</code> flag is <code>false</code>, and there is |
| already an instance in the cache with the same JDO identity as the |
| <code>oid</code> parameter, then this method returns it. There is no |
| change made to the state of the returned instance. |
| <P>If there is not an instance already in the cache with the same JDO |
| identity as the <code>oid</code> parameter, then this method creates an |
| instance with the specified JDO identity and returns it. If there is no |
| transaction in progress, the returned instance will be hollow or |
| persistent-nontransactional, at the choice of the implementation. |
| <P>If there is a transaction in progress, the returned instance will |
| be hollow, persistent-nontransactional, or persistent-clean, at the |
| choice of the implementation. |
| <P>It is an implementation decision whether to access the data store, |
| if required to determine the exact class. This will be the case of |
| inheritance, where multiple <code>PersistenceCapable</code> classes share |
| the same ObjectId class. |
| <P>If the validate flag is <code>false</code>, and the instance does not |
| exist in the data store, then this method might not fail. It is an |
| implementation choice whether to fail immediately with a |
| <code>JDOObjectNotFoundException</code>. But a subsequent access |
| of the fields of the |
| instance will throw a <code>JDOObjectNotFoundException</code> |
| if the instance does not |
| exist at that time. Further, if a relationship is established to this |
| instance, then the transaction in which the association was made will |
| fail. |
| <P>If the <code>validate</code> flag is <code>true</code>, and there is |
| already a transactional instance in the cache with the same JDO identity |
| as the <code>oid</code> parameter, then this method returns it. There is |
| no change made to the state of the returned instance. |
| <P>If there is an instance already in the cache with the same JDO |
| identity as the <code>oid</code> parameter, but the instance is not |
| transactional, then it must be verified in the data store. If the |
| instance does not exist in the datastore, then a |
| <code>JDOObjectNotFoundException</code> is thrown. |
| <P>If there is not an instance already in the cache with the same JDO |
| identity as the <code>oid</code> parameter, then this method creates an |
| instance with the specified JDO identity, verifies that it exists in the |
| data store, and returns it. If there is no transaction in progress, the |
| returned instance will be hollow or persistent-nontransactional, |
| at the choice of the implementation. |
| <P>If there is a data store transaction in progress, the returned |
| instance will be persistent-clean. |
| If there is an optimistic transaction in progress, the returned |
| instance will be persistent-nontransactional.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>oid</code> - an ObjectId</dd> |
| <dd><code>validate</code> - if the existence of the instance is to be validated</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>PersistenceCapable</code> instance with the specified |
| ObjectId</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#getObjectId-java.lang.Object-"><code>getObjectId(Object pc)</code></a>, |
| <a href="../../javax/jdo/PersistenceManager.html#getTransactionalObjectId-java.lang.Object-"><code>getTransactionalObjectId(Object pc)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getObjectById-java.lang.Class-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectById</h4> |
| <pre><T> T getObjectById(<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><T> cls, |
| <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> key)</pre> |
| <div class="block">Looks up the instance of the given type with the given key.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type of the persistable object being retrieved</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cls</code> - The type of object to load</dd> |
| <dd><code>key</code> - either the string representation of the object id, or |
| an object representation of a single field identity key</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding persistent instance</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getObjectById-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectById</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> getObjectById(<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> oid)</pre> |
| <div class="block">Looks up the instance corresponding to the specified oid. This is |
| equivalent to <code>getObjectById(oid, true);</code></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>oid</code> - The object id of the object to load</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the corresponding persistent instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getObjectId-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectId</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> getObjectId(<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> pc)</pre> |
| <div class="block">The ObjectId returned by this method represents the JDO identity of |
| the instance. The ObjectId is a copy (clone) of the internal state |
| of the instance, and changing it does not affect the JDO identity of |
| the instance. |
| <P>The <code>getObjectId</code> method returns an ObjectId instance that |
| represents the object identity of the specified JDO instance. The |
| identity is guaranteed to be unique only in the context of the JDO |
| <code>PersistenceManager</code> that created the identity, and only for |
| two types of JDO Identity: those that are managed by the application, and |
| those that are managed by the data store. |
| <P>If the object identity is being changed in the transaction, by the |
| application modifying one or more of the application key fields, |
| then this method returns the identity as of the beginning of the |
| transaction. The value returned by <code>getObjectId</code> will be |
| different following <code>afterCompletion</code> processing for |
| successful transactions. <P>Within a transaction, the ObjectId returned |
| will compare equal to the ObjectId returned by only one among all JDO |
| instances associated with the <code>PersistenceManager</code> regardless |
| of the type of ObjectId. |
| <P>The ObjectId does not necessarily contain any internal state of the |
| instance, nor is it necessarily an instance of the class used to |
| manage identity internally. Therefore, if the application makes a |
| change to the ObjectId instance returned by this method, there is |
| no effect on the instance from which the ObjectId was obtained. |
| <P>The <code>getObjectById</code> method can be used between instances of |
| <code>PersistenceManager</code> of different JDO vendors only for |
| instances of persistence capable classes using application-managed |
| (primary key) JDO identity. If it is used for instances of classes using |
| datastore identity, the method might succeed, but there are no guarantees |
| that the parameter and return instances are related in any way.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pc</code> - the <code>PersistenceCapable</code> instance</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ObjectId of the instance</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#getTransactionalObjectId-java.lang.Object-"><code>getTransactionalObjectId(Object pc)</code></a>, |
| <a href="../../javax/jdo/PersistenceManager.html#getObjectById-java.lang.Object-boolean-"><code>getObjectById(Object oid, boolean validate)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTransactionalObjectId-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransactionalObjectId</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> getTransactionalObjectId(<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> pc)</pre> |
| <div class="block">The ObjectId returned by this method represents the JDO identity of |
| the instance. The ObjectId is a copy (clone) of the internal state |
| of the instance, and changing it does not affect the JDO identity of |
| the instance. |
| <P>If the object identity is being changed in the transaction, by the |
| application modifying one or more of the application key fields, |
| then this method returns the current identity in the transaction. |
| <P>If there is no transaction in progress, or if none of the key fields |
| is being modified, then this method will return the same value as |
| <code>getObjectId</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pc</code> - a <code>PersistenceCapable</code> instance</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ObjectId of the instance</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#getObjectId-java.lang.Object-"><code>getObjectId(Object pc)</code></a>, |
| <a href="../../javax/jdo/PersistenceManager.html#getObjectById-java.lang.Object-boolean-"><code>getObjectById(Object oid, boolean validate)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newObjectIdInstance-java.lang.Class-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newObjectIdInstance</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> newObjectIdInstance(<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> pcClass, |
| <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> key)</pre> |
| <div class="block">This method returns an object id instance corresponding to the pcClass |
| and key arguments.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcClass</code> - the <code>Class</code> of the persistence-capable instance</dd> |
| <dd><code>key</code> - for single-field identity, the parameter for the |
| constructor; for non-single-field application identity, the result |
| of toString() on the object id instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an instance of the object identity class</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getObjectsById-java.util.Collection-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectsById</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> getObjectsById(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> oids, |
| boolean validate)</pre> |
| <div class="block">Return the objects with the given oids.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>oids</code> - the oids of the objects to return</dd> |
| <dd><code>validate</code> - if true, the existance of the objects in |
| the datastore will be validated.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the objects that were looked up, in the |
| same order as the oids parameter.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#getObjectById-java.lang.Object-boolean-"><code>getObjectById(Object,boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getObjectsById-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectsById</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> getObjectsById(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> oids)</pre> |
| <div class="block">Return the objects with the given oids. This method is equivalent |
| to calling <a href="../../javax/jdo/PersistenceManager.html#getObjectsById-java.util.Collection-boolean-"><code>getObjectsById(Collection, boolean)</code></a> |
| with the validate flag true.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>oids</code> - the oids of the objects to return</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the objects that were looked up, in the |
| same order as the oids parameter.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#getObjectsById-java.util.Collection-boolean-"><code>getObjectsById(Collection,boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getObjectsById-boolean-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectsById</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>[] getObjectsById(boolean validate, |
| <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>... oids)</pre> |
| <div class="block">Return the objects with the given oids.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>oids</code> - the oids of the objects to return</dd> |
| <dd><code>validate</code> - if true, the existance of the objects in |
| the datastore will be validated.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the objects that were looked up, in the |
| same order as the oids parameter.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#getObjectById-java.lang.Object-boolean-"><code>getObjectById(Object,boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getObjectsById-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectsById</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>[] getObjectsById(<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>... oids)</pre> |
| <div class="block">Return the objects with the given oids. This method is equivalent |
| to calling <a href="../../javax/jdo/PersistenceManager.html#getObjectsById-boolean-java.lang.Object...-"><code>getObjectsById(boolean,Object...)</code></a> |
| with the validate flag true.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>oids</code> - the oids of the objects to return</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the objects that were looked up, in the |
| same order as the oids parameter.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#getObjectsById-boolean-java.lang.Object...-"><code>getObjectsById(boolean,Object...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makePersistent-java.lang.Object-"> |
| <!-- --> |
| </a><a name="makePersistent-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makePersistent</h4> |
| <pre><T> T makePersistent(T pc)</pre> |
| <div class="block">Make the parameter instance persistent in this |
| <code>PersistenceManager</code>. |
| This method makes transient instances persistent and applies detached |
| instance changes to the cache. It must be called in the context of |
| an active transaction, or a JDOUserException is thrown. For a transient |
| instance, it assigns an object identity to the instance and transitions |
| it to persistent-new. Any transient instances reachable from this |
| instance via persistent fields of this instance become provisionally |
| persistent, transitively. That is, they behave as persistent-new |
| instances (return true to isPersistent, isNew, and isDirty). |
| But at commit time, the reachability algorithm is run again, |
| and instances made provisionally persistent that are not then |
| reachable from persistent instances will revert to transient. |
| <P>During makePersistent of transient instances, the create life cycle |
| listener is called. |
| <P>For detached instances, it locates or instantiates a persistent |
| instance with the same JDO identity as the detached instance, |
| and merges the persistent state of the detached instance into the |
| persistent instance. Only the state of persistent fields is merged. |
| If non-persistent state needs to be copied, the application should |
| use the jdoPostAttach callback or the postAttach lifecycle event |
| listener. Any references to the detached instances from instances |
| in the closure of the parameter instances are modified to refer to |
| the corresponding persistent instance instead of to the |
| detached instance. |
| <P>During attachment of detached instances, the attach callbacks |
| and attach life cycle listeners are called. |
| <P>During application of changes of the detached state, if the JDO |
| implementation can determine that there were no changes made during |
| detachment, then the implementation is not required to mark the |
| corresponding instance dirty. If it cannot determine if changes |
| were made, then it must mark the instance dirty. |
| No consistency checking is done during makePersistent of detached |
| instances. If consistency checking is required by the application, |
| then flush or checkConsistency should be called after attaching the |
| instances. |
| <P>These methods have no effect on parameter persistent instances |
| already managed by this PersistenceManager. They will throw a |
| JDOUserException if the parameter instance is managed by a |
| different PersistenceManager. |
| If an instance is of a class whose identity type (application, |
| datastore, or none) is not supported by the JDO implementation, |
| then a JDOUserException will be thrown for that instance. |
| The return value for parameter instances in the transient or persistent |
| states is the same as the parameter value. The return value for |
| parameter instances in the detached state is the persistent instance |
| corresponding to the detached instance. |
| The return values for makePersistentAll methods correspond by position |
| to the parameter instances.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type of the persistable object</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pc</code> - an instance of a <code>Class</code> that is persistent |
| capable.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the parameter instance for parameters in the transient or |
| persistent state, or the corresponding persistent instance |
| for detached parameter instances</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makePersistentAll-java.lang.Object:A-"> |
| <!-- --> |
| </a><a name="makePersistentAll-T...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makePersistentAll</h4> |
| <pre><T> T[] makePersistentAll(T... pcs)</pre> |
| <div class="block">Make an array of instances persistent.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type of the persistable object</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - an array of instances</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the parameter instances for parameters in the transient or |
| persistent state, or the corresponding persistent instance |
| for detached parameter instances, in the same order as in the |
| parameter array</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#makePersistent-T-"><code>makePersistent(Object pc)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makePersistentAll-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makePersistentAll</h4> |
| <pre><T> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><T> makePersistentAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><T> pcs)</pre> |
| <div class="block">Make a <code>Collection</code> of instances persistent.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type of the persistable object</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - a <code>Collection</code> of instances</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the parameter instance for parameters in the transient or |
| persistent state, or the corresponding persistent instance |
| for detached parameter instances, with an iteration in the same order |
| as in the parameter Collection</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#makePersistent-T-"><code>makePersistent(Object pc)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deletePersistent-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deletePersistent</h4> |
| <pre>void deletePersistent(<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> pc)</pre> |
| <div class="block">Delete the persistent instance from the data store. |
| This method must be called in an active transaction. |
| The data store object will be removed at commit. |
| Unlike <code>makePersistent</code>, which makes the closure of the |
| instance persistent, the closure of the instance is not deleted from the |
| data store. This method has no effect if the instance is already deleted |
| in the current transaction. |
| This method throws <code>JDOUserException</code> if the instance is |
| transient or is managed by another <code>PersistenceManager</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pc</code> - a persistent instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deletePersistentAll-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deletePersistentAll</h4> |
| <pre>void deletePersistentAll(<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>... pcs)</pre> |
| <div class="block">Delete an array of instances from the data store.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - a <code>Collection</code> of persistent instances</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#deletePersistent-java.lang.Object-"><code>deletePersistent(Object pc)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deletePersistentAll-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deletePersistentAll</h4> |
| <pre>void deletePersistentAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs)</pre> |
| <div class="block">Delete a <code>Collection</code> of instances from the data store.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - a <code>Collection</code> of persistent instances</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#deletePersistent-java.lang.Object-"><code>deletePersistent(Object pc)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makeTransient-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeTransient</h4> |
| <pre>void makeTransient(<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> pc)</pre> |
| <div class="block">Make an instance transient, removing it from management by this |
| <code>PersistenceManager</code>. |
| |
| <P>The instance loses its JDO identity and it is no longer associated |
| with any <code>PersistenceManager</code>. The state of fields is |
| preserved unchanged.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pc</code> - the instance to make transient.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makeTransientAll-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeTransientAll</h4> |
| <pre>void makeTransientAll(<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>... pcs)</pre> |
| <div class="block">Make an array of instances transient, removing them from management by |
| this <code>PersistenceManager</code>. |
| |
| <P>The instances lose their JDO identity and they are no longer |
| associated with any <code>PersistenceManager</code>. The state of fields |
| is preserved unchanged.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the instances to make transient.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makeTransientAll-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeTransientAll</h4> |
| <pre>void makeTransientAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs)</pre> |
| <div class="block">Make a <code>Collection</code> of instances transient, removing them |
| from management by this <code>PersistenceManager</code>. |
| |
| <P>The instances lose their JDO identity and they are no longer |
| associated with any <code>PersistenceManager</code>. The state of fields |
| is preserved unchanged.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the instances to make transient.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makeTransient-java.lang.Object-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeTransient</h4> |
| <pre>void makeTransient(<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> pc, |
| boolean useFetchPlan)</pre> |
| <div class="block">Make an instance transient, removing it from management by this |
| <code>PersistenceManager</code>. If the useFetchPlan parameter is |
| false, this method behaves exactly as makeTransient(Object pc). |
| <P>The affected instance(s) lose their JDO identity and are no longer |
| associated with any <code>PersistenceManager</code>. The state |
| of fields is unchanged. |
| <P>If the useFetchPlan parameter is true, then the current FetchPlan |
| is applied to the pc parameter, as if detachCopy(Object) had been |
| called. After the graph of instances is loaded, the instances |
| reachable via loaded fields is made transient. The state of fields |
| in the affected instances is as specified by the FetchPlan. |
| <P>Unlike detachCopy, the instances are not detached; there is no |
| detachment information in the instances. |
| <P>The instances to be made transient do not need to |
| implement the javax.jdo.spi.Detachable interface.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pc</code> - the root instance to make transient.</dd> |
| <dd><code>useFetchPlan</code> - whether to use the current fetch plan to determine |
| which fields to load and which instances to make transient</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makeTransientAll-boolean-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeTransientAll</h4> |
| <pre>void makeTransientAll(boolean useFetchPlan, |
| <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>... pcs)</pre> |
| <div class="block">Make instances transient, removing them from management |
| by this <code>PersistenceManager</code>. If the useFetchPlan parameter |
| is false, this method behaves exactly as makeTransientAll(Object[] pcs). |
| <P>The affected instance(s) lose their JDO identity and are no longer |
| associated with any <code>PersistenceManager</code>. The state |
| of fields is unchanged. |
| <P>If the useFetchPlan parameter is true, then the current FetchPlan |
| is applied to the pcs parameters and the entire graph of instances |
| reachable via loaded fields is made transient. The state of fields |
| in the affected instances is as specified by the FetchPlan. |
| <P>Unlike detachCopy, the instances are not detached; there is no |
| detachment information in the instances. |
| <P>The instances to be made transient do not need to |
| implement the javax.jdo.spi.Detachable interface.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the root instances to make transient.</dd> |
| <dd><code>useFetchPlan</code> - whether to use the current fetch plan to determine |
| which fields to load and which instances to make transient</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makeTransientAll-java.util.Collection-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeTransientAll</h4> |
| <pre>void makeTransientAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs, |
| boolean useFetchPlan)</pre> |
| <div class="block">Make instances transient, removing them from management |
| by this <code>PersistenceManager</code>. If the useFetchPlan parameter |
| is false, this method behaves exactly as |
| makeTransientAll(Collection pcs). |
| <P>The affected instance(s) lose their JDO identity and are no longer |
| associated with any <code>PersistenceManager</code>. The state |
| of fields is unchanged. |
| <P>If the useFetchPlan parameter is true, then the current FetchPlan |
| is applied to the pcs parameters and the entire graph of instances |
| reachable via loaded fields is made transient. The state of fields |
| in the affected instances is as specified by the FetchPlan. |
| <P>Unlike detachCopy, the instances are not detached; there is no |
| detachment information in the instances. |
| <P>The instances to be made transient do not need to |
| implement the javax.jdo.spi.Detachable interface.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the root instances to make transient.</dd> |
| <dd><code>useFetchPlan</code> - whether to use the current fetch plan to determine |
| which fields to load and which instances to make transient</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makeTransactional-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeTransactional</h4> |
| <pre>void makeTransactional(<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> pc)</pre> |
| <div class="block">Make an instance subject to transactional boundaries. |
| |
| <P>Transient instances normally do not observe transaction boundaries. |
| This method makes transient instances sensitive to transaction |
| completion. If an instance is modified in a transaction, and the |
| transaction rolls back, the state of the instance is restored to the |
| state before the first change in the transaction. |
| |
| <P>For persistent instances read in optimistic transactions, this method |
| allows the application to make the state of the instance part of the |
| transactional state. At transaction commit, the state of the instance in |
| the cache is compared to the state of the instance in the data store. If |
| they are not the same, then an exception is thrown.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pc</code> - the instance to make transactional.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makeTransactionalAll-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeTransactionalAll</h4> |
| <pre>void makeTransactionalAll(<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>... pcs)</pre> |
| <div class="block">Make an array of instances subject to transactional boundaries.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the array of instances to make transactional.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#makeTransactional-java.lang.Object-"><code>makeTransactional(Object pc)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makeTransactionalAll-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeTransactionalAll</h4> |
| <pre>void makeTransactionalAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs)</pre> |
| <div class="block">Make a <code>Collection</code> of instances subject to transactional |
| boundaries.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the <code>Collection</code> of instances to make |
| transactional.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#makeTransactional-java.lang.Object-"><code>makeTransactional(Object pc)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makeNontransactional-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeNontransactional</h4> |
| <pre>void makeNontransactional(<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> pc)</pre> |
| <div class="block">Make an instance non-transactional after commit. |
| |
| <P>Normally, at transaction completion, instances are evicted from the |
| cache. This method allows an application to identify an instance as |
| not being evicted from the cache at transaction completion. Instead, |
| the instance remains in the cache with nontransactional state.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pc</code> - the instance to make nontransactional.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makeNontransactionalAll-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeNontransactionalAll</h4> |
| <pre>void makeNontransactionalAll(<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>... pcs)</pre> |
| <div class="block">Make an array of instances non-transactional after commit.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the array of instances to make nontransactional.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#makeNontransactional-java.lang.Object-"><code>makeNontransactional(Object pc)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makeNontransactionalAll-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeNontransactionalAll</h4> |
| <pre>void makeNontransactionalAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs)</pre> |
| <div class="block">Make a <code>Collection</code> of instances non-transactional after |
| commit.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the <code>Collection</code> of instances to make |
| nontransactional.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#makeNontransactional-java.lang.Object-"><code>makeNontransactional(Object pc)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="retrieve-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>retrieve</h4> |
| <pre>void retrieve(<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> pc)</pre> |
| <div class="block">Retrieve field values of an instance from the store. This tells |
| the <code>PersistenceManager</code> that the application intends to use |
| the instance, and its field values must be retrieved. |
| <P>The <code>PersistenceManager</code> might use policy information about |
| the class to retrieve associated instances.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pc</code> - the instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="retrieve-java.lang.Object-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>retrieve</h4> |
| <pre>void retrieve(<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> pc, |
| boolean useFetchPlan)</pre> |
| <div class="block">Retrieve field values of an instance from the store. This tells |
| the <code>PersistenceManager</code> that the application intends to use |
| the instance, and its field values must be retrieved. |
| <P>If the useFetchPlan parameter is false, this method behaves exactly |
| as the corresponding method without the useFetchPlan parameter. |
| If the useFetchPlan parameter is true, and the fetch plan has not been |
| modified from its default setting, all fields in the current fetch plan |
| are fetched, and other fields might be fetched lazily by the |
| implementation. If the useFetchPlan parameter is true, and the fetch |
| plan has been changed from its default setting, then the fields |
| specified by the fetch plan are loaded, along with related instances |
| specified by the fetch plan.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pc</code> - the instance</dd> |
| <dd><code>useFetchPlan</code> - whether to use the current fetch plan to determine |
| which fields to load and which instances to retrieve.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="retrieveAll-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>retrieveAll</h4> |
| <pre>void retrieveAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs)</pre> |
| <div class="block">Retrieve field values of instances from the store. This tells |
| the <code>PersistenceManager</code> that the application intends to use |
| the instances, and all field values must be retrieved. |
| <P>The <code>PersistenceManager</code> might use policy information about |
| the class to retrieve associated instances.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the instances</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="retrieveAll-java.util.Collection-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>retrieveAll</h4> |
| <pre>void retrieveAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> pcs, |
| boolean useFetchPlan)</pre> |
| <div class="block">Retrieve field values of instances from the store. This tells |
| the <code>PersistenceManager</code> that the application intends to use |
| the instances, and their field values should be retrieved. The fields |
| in the current fetch group must be retrieved, and the implementation |
| might retrieve more fields than the current fetch group. |
| <P>If the useFetchPlan parameter is false, this method behaves exactly |
| as the corresponding method without the useFetchPlan parameter. |
| If the useFetchPlan parameter is true, and the fetch plan has not been |
| modified from its default setting, all fields in the current fetch plan |
| are fetched, and other fields might be fetched lazily by the |
| implementation. If the useFetchPlan parameter is true, and the fetch |
| plan has been changed from its default setting, then the fields |
| specified by the fetch plan are loaded, along with related instances |
| specified by the fetch plan.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the instances</dd> |
| <dd><code>useFetchPlan</code> - whether to use the current fetch plan to determine |
| which fields to load and which instances to retrieve.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="retrieveAll-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>retrieveAll</h4> |
| <pre>void retrieveAll(<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>... pcs)</pre> |
| <div class="block">Retrieve field values of instances from the store. This tells |
| the <code>PersistenceManager</code> that the application intends to use |
| the instances, and all field values must be retrieved. |
| <P>The <code>PersistenceManager</code> might use policy information about |
| the class to retrieve associated instances.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the instances</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="retrieveAll-boolean-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>retrieveAll</h4> |
| <pre>void retrieveAll(boolean useFetchPlan, |
| <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>... pcs)</pre> |
| <div class="block">Retrieve field values of instances from the store. This tells |
| the <code>PersistenceManager</code> that the application intends to use |
| the instances, and their field values should be retrieved. The fields |
| in the current fetch group must be retrieved, and the implementation |
| might retrieve more fields than the current fetch group. |
| <P>If the useFetchPlan parameter is false, this method behaves exactly |
| as the corresponding method without the useFetchPlan parameter. |
| If the useFetchPlan parameter is true, and the fetch plan has not been |
| modified from its default setting, all fields in the current fetch plan |
| are fetched, and other fields might be fetched lazily by the |
| implementation. If the useFetchPlan parameter is true, and the fetch |
| plan has been changed from its default setting, then the fields |
| specified by the fetch plan are loaded, along with related instances |
| specified by the fetch plan.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the instances</dd> |
| <dd><code>useFetchPlan</code> - whether to use the current fetch plan to determine |
| which fields to load and which instances to retrieve.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setUserObject-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUserObject</h4> |
| <pre>void setUserObject(<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> o)</pre> |
| <div class="block">The application can manage the <code>PersistenceManager</code> instances |
| more easily by having an application object associated with each |
| <code>PersistenceManager</code> instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>o</code> - the user instance to be remembered by the |
| <code>PersistenceManager</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#getUserObject--"><code>getUserObject()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUserObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUserObject</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> getUserObject()</pre> |
| <div class="block">The application can manage the <code>PersistenceManager</code> instances |
| more easily by having an application object associated with each |
| <code>PersistenceManager</code> instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the user object associated with this |
| <code>PersistenceManager</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#setUserObject-java.lang.Object-"><code>setUserObject(java.lang.Object)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPersistenceManagerFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPersistenceManagerFactory</h4> |
| <pre><a href="../../javax/jdo/PersistenceManagerFactory.html" title="interface in javax.jdo">PersistenceManagerFactory</a> getPersistenceManagerFactory()</pre> |
| <div class="block">This method returns the <code>PersistenceManagerFactory</code> used to |
| create this <code>PersistenceManager</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>PersistenceManagerFactory</code> that created |
| this <code>PersistenceManager</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getObjectIdClass-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectIdClass</h4> |
| <pre><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> getObjectIdClass(<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> cls)</pre> |
| <div class="block">Return the <code>Class</code> that implements the JDO Identity for the |
| specified <code>PersistenceCapable</code> class. The application can use |
| the returned <code>Class</code> to construct a JDO Identity instance for |
| application identity <code>PersistenceCapable</code> classes. This JDO |
| Identity instance can then be used to get an instance of the |
| <code>PersistenceCapable</code> class for use in the application. |
| |
| <P>In order for the application to construct an instance of the ObjectId |
| class it needs to know the class being used by the JDO implementation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cls</code> - the <code>PersistenceCapable Class</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Class</code> of the ObjectId of the parameter</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#getObjectById-java.lang.Object-boolean-"><code>getObjectById(java.lang.Object, boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMultithreaded-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMultithreaded</h4> |
| <pre>void setMultithreaded(boolean flag)</pre> |
| <div class="block">Set the Multithreaded flag for this <code>PersistenceManager</code>. |
| Applications that use multiple threads to invoke methods or access fields |
| from instances managed by this <code>PersistenceManager</code> must set |
| this flag to <code>true</code>. |
| Instances managed by this <code>PersistenceManager</code> include |
| persistent or transactional instances of <code>PersistenceCapable</code> |
| classes, as well as helper instances such as <code>Query</code>, |
| <code>Transaction</code>, or <code>Extent</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - the Multithreaded setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMultithreaded--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMultithreaded</h4> |
| <pre>boolean getMultithreaded()</pre> |
| <div class="block">Get the current Multithreaded flag for this |
| <code>PersistenceManager</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Multithreaded setting.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#setMultithreaded-boolean-"><code>setMultithreaded(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIgnoreCache-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIgnoreCache</h4> |
| <pre>void setIgnoreCache(boolean flag)</pre> |
| <div class="block">Set the ignoreCache parameter for queries. |
| |
| <P>IgnoreCache set to <code>true</code> specifies that for all |
| <code>Query</code> instances created by this |
| <code>PersistenceManager</code>, the default is the cache should be |
| ignored for queries.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - the ignoreCache setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIgnoreCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIgnoreCache</h4> |
| <pre>boolean getIgnoreCache()</pre> |
| <div class="block">Get the ignoreCache setting for queries. |
| |
| <P>IgnoreCache set to <code>true</code> specifies that for all |
| <code>Query</code> instances created by this |
| <code>PersistenceManager</code>, the default is the cache should be |
| ignored for queries.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ignoreCache setting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDatastoreReadTimeoutMillis-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDatastoreReadTimeoutMillis</h4> |
| <pre>void setDatastoreReadTimeoutMillis(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> interval)</pre> |
| <div class="block">Specify a timeout interval (milliseconds) for any datastore read |
| operations associated with this persistence manager. To unset |
| the explicit timeout, specify null. For no timeout, specify 0. |
| Read operations include, for example, those associated with query, |
| getObjectById, refresh, retrieve, and extent iteration operations. |
| If the datastore granularity is larger than milliseconds, the |
| timeout value will be rounded up to the nearest supported datastore |
| value. |
| If a read operation hasn't completed within this interval, the operation |
| will throw a JDODatastoreException. |
| If multiple datastore operations are required to complete the query, |
| the timeout value applies to each of them individually. |
| If the datastore and JDO implementation support timeouts, then |
| javax.jdo.option.DatastoreTimeout is returned by |
| PersistenceManagerFactory.supportedOptions(). |
| If timeouts are not supported,this method will throw |
| JDOUnsupportedOptionException.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>interval</code> - the timeout interval (milliseconds)</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDatastoreReadTimeoutMillis--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDatastoreReadTimeoutMillis</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getDatastoreReadTimeoutMillis()</pre> |
| <div class="block">Get the effective timeout setting for datastore read operations |
| associated with this persistence manager. |
| If the timeout has not been set on this persistence manager explicitly, |
| the default read timeout value from the persistence manager factory |
| is returned.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the effective timeout setting (milliseconds).</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#setDatastoreReadTimeoutMillis-java.lang.Integer-"><code>setDatastoreReadTimeoutMillis(Integer)</code></a>, |
| <a href="../../javax/jdo/PersistenceManagerFactory.html#setDatastoreReadTimeoutMillis-java.lang.Integer-"><code>PersistenceManagerFactory.setDatastoreReadTimeoutMillis(Integer)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDatastoreWriteTimeoutMillis-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDatastoreWriteTimeoutMillis</h4> |
| <pre>void setDatastoreWriteTimeoutMillis(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> interval)</pre> |
| <div class="block">Specify a timeout interval (milliseconds) for any write operations |
| associated with this persistence manager. To unset the explicit timeout, |
| specify null. For no timeout, specify 0. |
| Datastore write operations include, for example, operations associated |
| with flush, commit, and delete by query. |
| If the datastore granularity is larger than milliseconds, the |
| timeout value will be rounded up to the nearest supported datastore |
| value. |
| If a write operation hasn't completed within this interval, methods |
| will throw a JDODatastoreException. |
| If multiple datastore operations are required to complete the method, |
| the timeout value applies to each of them individually. |
| If the datastore and JDO implementation support timeouts, then |
| javax.jdo.option.DatastoreTimeout is returned by |
| PersistenceManagerFactory.supportedOptions(). |
| If timeouts are not supported,this method will throw |
| JDOUnsupportedOptionException.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>interval</code> - the timeout interval (milliseconds)</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDatastoreWriteTimeoutMillis--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDatastoreWriteTimeoutMillis</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getDatastoreWriteTimeoutMillis()</pre> |
| <div class="block">Get the effective timeout setting for write operations. |
| If the timeout has not been set on this persistence manager explicitly, |
| the default datastore write timeout value from the persistence manager |
| factory is returned.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the effective timeout setting (milliseconds).</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#setDatastoreWriteTimeoutMillis-java.lang.Integer-"><code>setDatastoreWriteTimeoutMillis(Integer)</code></a>, |
| <a href="../../javax/jdo/PersistenceManagerFactory.html#setDatastoreWriteTimeoutMillis-java.lang.Integer-"><code>PersistenceManagerFactory.setDatastoreWriteTimeoutMillis(Integer)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDetachAllOnCommit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDetachAllOnCommit</h4> |
| <pre>boolean getDetachAllOnCommit()</pre> |
| <div class="block">Gets the detachAllOnCommit setting.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the detachAllOnCommit setting.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#setDetachAllOnCommit-boolean-"><code>setDetachAllOnCommit(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDetachAllOnCommit-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDetachAllOnCommit</h4> |
| <pre>void setDetachAllOnCommit(boolean flag)</pre> |
| <div class="block">Sets the detachAllOnCommit setting. |
| |
| <P>DetachAllOnCommit set to <code>false</code> specifies that the |
| state of persistent instances in the cache after commit is defined |
| by the <code>retainValues</code> flag. With this flag set to true, |
| during beforeCompletion all cached instances are prepared for |
| detachment according to the fetch plan in effect at commit. Loading |
| fields and unloading fields required by the fetch plan is done after |
| calling the user's <code>beforeCompletion</code> callback. During |
| <code>afterCompletion</code>, before calling the user's |
| <code>afterCompletion</code> callback, all detachable persistent |
| instances in the cache transition to detached; non-detachable |
| persistent instances transition to transient; and detachable |
| instances can be serialized as detached instances. Transient |
| transactional instances are unaffected by this flag.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - Flag for whether to detach all on commit</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#getDetachAllOnCommit--"><code>getDetachAllOnCommit()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCopyOnAttach--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCopyOnAttach</h4> |
| <pre>boolean getCopyOnAttach()</pre> |
| <div class="block">Gets the copyOnAttach setting.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the copyOnAttach setting.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#setCopyOnAttach-boolean-"><code>setCopyOnAttach(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCopyOnAttach-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCopyOnAttach</h4> |
| <pre>void setCopyOnAttach(boolean flag)</pre> |
| <div class="block">Sets the copyOnAttach setting. |
| |
| <P>CopyOnAttach set to <code>true</code> specifies that during |
| makePersistent, copies are made of detached parameter instances. |
| With this flag set to <code>false</code>, detached parameter |
| instances are attached directly and change their state from |
| detached-clean to persistent-clean or from detached-dirty to |
| persistent-dirty.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - Flag for whether to copy on attach</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#getCopyOnAttach--"><code>getCopyOnAttach()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="detachCopy-java.lang.Object-"> |
| <!-- --> |
| </a><a name="detachCopy-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>detachCopy</h4> |
| <pre><T> T detachCopy(T pc)</pre> |
| <div class="block">Detach the specified instance from the <code>PersistenceManager</code>. |
| The flags for detachment (DETACH_LOAD_FIELDS and DETACH_UNLOAD_FIELDS) |
| and the active fetch groups determine the scope of fetching for the |
| graph of instances reachable from the pc parameter. The state of fields |
| in the affected instances is as specified by the FetchPlan.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type of the persistable object</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pc</code> - the instance to detach</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the detached instance</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#detachCopyAll-T...-"><code>detachCopyAll(Object[])</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="detachCopyAll-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>detachCopyAll</h4> |
| <pre><T> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><T> detachCopyAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><T> pcs)</pre> |
| <div class="block">Detach the specified instances from the <code>PersistenceManager</code>. |
| The flags for detachment (DETACH_LOAD_FIELDS and DETACH_UNLOAD_FIELDS) |
| and the active fetch groups determine the scope of fetching for the |
| graph of instances reachable from the pcs parameter. The state of fields |
| in the affected instances is as specified by the FetchPlan.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type of the persistable objects</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the instances to detach</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the detached instances</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#detachCopyAll-T...-"><code>detachCopyAll(Object[])</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="detachCopyAll-java.lang.Object:A-"> |
| <!-- --> |
| </a><a name="detachCopyAll-T...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>detachCopyAll</h4> |
| <pre><T> T[] detachCopyAll(T... pcs)</pre> |
| <div class="block">Detach the specified instances from the <code>PersistenceManager</code>. |
| The flags for detachment (DETACH_LOAD_FIELDS and DETACH_UNLOAD_FIELDS) |
| and the active fetch groups determine the scope of fetching for the |
| graph of instances reachable from the pcs parameter. The state of fields |
| in the affected instances is as specified by the FetchPlan. |
| The objects returned can be manipulated and re-attached with |
| <a href="../../javax/jdo/PersistenceManager.html#makePersistentAll-T...-"><code>makePersistentAll(Object[])</code></a>. |
| The detached instances will be |
| unmanaged copies of the specified parameters, and are suitable |
| for serialization and manipulation outside of a JDO |
| environment. When detaching instances, only fields in the |
| current <a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo"><code>FetchPlan</code></a> will be traversed. Thus, to detach a |
| graph of objects, relations to other persistent instances must |
| either be in the <code>default-fetch-group</code>, or in the |
| current custom <a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo"><code>FetchPlan</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type of the persistable object</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcs</code> - the instances to detach</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the detached instances</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if any of the instances to be detached do not |
| implement the javax.jdo.spi.Detachable interface.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../javax/jdo/PersistenceManager.html#makePersistentAll-T...-"><code>makePersistentAll(Object[])</code></a>, |
| <a href="../../javax/jdo/PersistenceManager.html#getFetchPlan--"><code>getFetchPlan()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putUserObject-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putUserObject</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> putUserObject(<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> key, |
| <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> val)</pre> |
| <div class="block">Put the specified key-value pair into the map of user objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - Key to store the user object under</dd> |
| <dd><code>val</code> - User object to store</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The previous object under this key</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUserObject-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUserObject</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> getUserObject(<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> key)</pre> |
| <div class="block">Get the value for the specified key from the map of user objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key of the object to be returned</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeUserObject-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeUserObject</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> removeUserObject(<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> key)</pre> |
| <div class="block">Remove the specified key and its value from the map of user objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key of the object to be removed</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The user object that was removed</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="flush--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>flush</h4> |
| <pre>void flush()</pre> |
| <div class="block">Flushes all dirty, new, and deleted instances to the data |
| store. It has no effect if a transaction is not active. |
| <p>If a datastore transaction is active, this method |
| synchronizes the cache with the datastore and reports any |
| exceptions.</p> |
| <p>If an optimistic transaction is active, this method obtains |
| a datastore connection, synchronizes the cache with the |
| datastore using this connection and reports any |
| exceptions. The connection obtained by this method is held |
| until the end of the transaction.</p> |
| <p>If exceptions occur during flush, the implementation will |
| set the current transaction's <code>RollbackOnly</code> flag |
| (see <a href="../../javax/jdo/Transaction.html#setRollbackOnly--"><code>Transaction.setRollbackOnly()</code></a>).</p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkConsistency--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkConsistency</h4> |
| <pre>void checkConsistency()</pre> |
| <div class="block">Validates the <code>PersistenceManager</code> cache with the |
| datastore. This method has no effect if a transaction is not |
| active. |
| <p>If a datastore transaction is active, this method verifies |
| the consistency of instances in the cache against the |
| datastore. An implementation might flush instances as if |
| <a href="../../javax/jdo/PersistenceManager.html#flush--"><code>flush()</code></a> were called, but it is not required to do |
| so.</p> |
| <p>If an optimistic transaction is active, this method obtains |
| a datastore connection and verifies the consistency of the |
| instances in the cache against the datastore. If any |
| inconsistencies are detected, a <a href="../../javax/jdo/JDOOptimisticVerificationException.html" title="class in javax.jdo"><code>JDOOptimisticVerificationException</code></a> is thrown. This exception |
| contains a nested <a href="../../javax/jdo/JDOOptimisticVerificationException.html" title="class in javax.jdo"><code>JDOOptimisticVerificationException</code></a> |
| for each object that failed the consistency check. No |
| datastore resources acquired during the execution of this |
| method are held beyond the scope of this method.</p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFetchPlan--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchPlan</h4> |
| <pre><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a> getFetchPlan()</pre> |
| <div class="block">Returns the <code>FetchPlan</code> used by this |
| <code>PersistenceManager</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the FetchPlan</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newInstance-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newInstance</h4> |
| <pre><T> T newInstance(<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><T> pcClass)</pre> |
| <div class="block">Creates an instance of a persistence-capable interface, |
| or of a concrete or abstract class. |
| The returned instance is transient.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type of the persistable object</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pcClass</code> - Must be a persistence-capable interface, |
| or a concrete or abstract class that is declared in the metadata.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the created instance</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSequence-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSequence</h4> |
| <pre><a href="../../javax/jdo/datastore/Sequence.html" title="interface in javax.jdo.datastore">Sequence</a> getSequence(<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> name)</pre> |
| <div class="block">Returns the sequence identified by <code>name</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the Sequence</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Sequence</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDataStoreConnection--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataStoreConnection</h4> |
| <pre><a href="../../javax/jdo/datastore/JDOConnection.html" title="interface in javax.jdo.datastore">JDOConnection</a> getDataStoreConnection()</pre> |
| <div class="block">If this method is called while a datastore transaction is |
| active, the object returned will be enlisted in the current |
| transaction. If called in an optimistic transaction or outside |
| an active transaction, the object returned will not be |
| enlisted in any transaction.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the JDOConnection instance</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addInstanceLifecycleListener-javax.jdo.listener.InstanceLifecycleListener-java.lang.Class...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addInstanceLifecycleListener</h4> |
| <pre>void addInstanceLifecycleListener(<a href="../../javax/jdo/listener/InstanceLifecycleListener.html" title="interface in javax.jdo.listener">InstanceLifecycleListener</a> listener, |
| <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>... classes)</pre> |
| <div class="block">Adds the listener instance to the list of lifecycle event |
| listeners. The <code>classes</code> parameter identifies all |
| of the classes of interest. If the <code>classes</code> |
| parameter is specified as <code>null</code>, events for all |
| persistent classes and interfaces will be sent to |
| <code>listenerInstance</code>. |
| <p>The listenerInstance will be called for each event for which it |
| implements the corresponding listenerInstance interface.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the lifecycle listener</dd> |
| <dd><code>classes</code> - the classes of interest to the listener</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeInstanceLifecycleListener-javax.jdo.listener.InstanceLifecycleListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeInstanceLifecycleListener</h4> |
| <pre>void removeInstanceLifecycleListener(<a href="../../javax/jdo/listener/InstanceLifecycleListener.html" title="interface in javax.jdo.listener">InstanceLifecycleListener</a> listener)</pre> |
| <div class="block">Removes the listener instance from the list of lifecycle event listeners.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the listener instance to be removed</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServerDate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerDate</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> getServerDate()</pre> |
| <div class="block">Get the Date as seen by the server. |
| Clients using this method can order their operations according to |
| a single time source. Implementations use the setting of the |
| server time zone to prepare a Date instance that represents |
| UTC time on the server.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Date instance corresponding to the UTC Date |
| as seen by the server</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getManagedObjects--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManagedObjects</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a> getManagedObjects()</pre> |
| <div class="block">Get the objects managed by this persistence manager.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the objects</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getManagedObjects-java.util.EnumSet-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManagedObjects</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a> getManagedObjects(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../javax/jdo/ObjectState.html" title="enum in javax.jdo">ObjectState</a>> states)</pre> |
| <div class="block">Get the objects managed by this persistence manager having the |
| specified object states.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>states</code> - The states of objects that we are interested in</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the objects</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getManagedObjects-java.lang.Class...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManagedObjects</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a> getManagedObjects(<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>... classes)</pre> |
| <div class="block">Get the objects managed by this persistence manager being instances of |
| the specified classes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classes</code> - The classes of objects that we are interested in</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the objects</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getManagedObjects-java.util.EnumSet-java.lang.Class...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManagedObjects</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a> getManagedObjects(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../javax/jdo/ObjectState.html" title="enum in javax.jdo">ObjectState</a>> states, |
| <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>... classes)</pre> |
| <div class="block">Get the objects managed by this persistence manager having the |
| specified object states and being instances of the specified classes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>states</code> - The states of objects that we are interested in</dd> |
| <dd><code>classes</code> - The classes of objects that we are interested in</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the objects</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFetchGroup-java.lang.Class-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchGroup</h4> |
| <pre><a href="../../javax/jdo/FetchGroup.html" title="interface in javax.jdo">FetchGroup</a> getFetchGroup(<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> cls, |
| <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> name)</pre> |
| <div class="block">Get a modifiable <code>FetchGroup</code> for the Class and name. |
| If a modifiable <code>FetchGroup</code> already exists in the |
| <code>PersistenceManager</code> scope, return it. |
| If not, create and populate a new <code>FetchGroup</code> from the |
| existing definition in the <a href="../../javax/jdo/PersistenceManager.html" title="interface in javax.jdo"><code>PersistenceManager</code></a> or |
| <a href="../../javax/jdo/PersistenceManagerFactory.html" title="interface in javax.jdo"><code>PersistenceManagerFactory</code></a>. If the definition for the |
| <code>FetchGroup</code> is not in scope in either the |
| <code>PersistenceManager</code> or |
| <code>PersistenceManagerFactory</code>, create it with no members. |
| The <code>FetchGroup</code> immediately |
| becomes active and in scope of the PersistenceManager, and hides |
| the corresponding fetch group in the PersistenceManagerFactory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cls</code> - the class or interface for the <code>FetchGroup</code></dd> |
| <dd><code>name</code> - the name of the fetch group</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the FetchGroup</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the class is not a persistence-capable |
| class or interface</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setProperty-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperty</h4> |
| <pre>void setProperty(<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> propertyName, |
| <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> value)</pre> |
| <div class="block">Set a persistence manager property. This can be a standard property |
| or a vendor-extension property. If a vendor-extension property is |
| not recognized, it is silently ignored.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>propertyName</code> - name of property</dd> |
| <dd><code>value</code> - The value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jdo/JDOUserException.html" title="class in javax.jdo">JDOUserException</a></code> - if the value is not supported for the property</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,<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>> getProperties()</pre> |
| <div class="block">Get the properties and associated values currently in effect for the |
| persistence manager. Changing entries in the map will not have affect |
| the configuration of the persistence manager.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>map of properties in effect</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSupportedProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSupportedProperties</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<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>> getSupportedProperties()</pre> |
| <div class="block">Get the names of the properties that are supported for use with the |
| persistence manager. These can be standard JDO properties, or can be |
| vendor-extension properties.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>property names Names of the properties accepted</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</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="class-use/PersistenceManager.html">Use</a></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="../../javax/jdo/ObjectState.html" title="enum in javax.jdo"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../javax/jdo/PersistenceManagerFactory.html" title="interface in javax.jdo"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?javax/jdo/PersistenceManager.html" target="_top">Frames</a></li> |
| <li><a href="PersistenceManager.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2005–2022 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |