blob: ac8787bdfe5d8038a55bb52b99ff7a3800d9a1cc [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PersistenceCapable.ObjectIdFieldSupplier (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="PersistenceCapable.ObjectIdFieldSupplier (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};
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/PersistenceCapable.ObjectIdFieldSupplier.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/spi/PersistenceCapable.ObjectIdFieldManager.html" title="interface in javax.jdo.spi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/jdo/spi/RegisterClassEvent.html" title="class in javax.jdo.spi"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html" target="_top">Frames</a></li>
<li><a href="PersistenceCapable.ObjectIdFieldSupplier.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">javax.jdo.spi</div>
<h2 title="Interface PersistenceCapable.ObjectIdFieldSupplier" class="title">Interface PersistenceCapable.ObjectIdFieldSupplier</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldManager.html" title="interface in javax.jdo.spi">PersistenceCapable.ObjectIdFieldManager</a></dd>
</dl>
<dl>
<dt>Enclosing interface:</dt>
<dd><a href="../../../javax/jdo/spi/PersistenceCapable.html" title="interface in javax.jdo.spi">PersistenceCapable</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">PersistenceCapable.ObjectIdFieldSupplier</span></pre>
<div class="block">This interface is used to provide fields to the Object id instance. It is used
by the method copyKeyFieldsToObjectId. When the method is called, the
generated code calls the instance of ObjectIdFieldManager for each field in
the object id.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchBooleanField-int-">fetchBooleanField</a></span>(int&nbsp;fieldNumber)</code>
<div class="block">Fetch one field from the field manager.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>byte</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchByteField-int-">fetchByteField</a></span>(int&nbsp;fieldNumber)</code>
<div class="block">Fetch one field from the field manager.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>char</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchCharField-int-">fetchCharField</a></span>(int&nbsp;fieldNumber)</code>
<div class="block">Fetch one field from the field manager.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchDoubleField-int-">fetchDoubleField</a></span>(int&nbsp;fieldNumber)</code>
<div class="block">Fetch one field from the field manager.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchFloatField-int-">fetchFloatField</a></span>(int&nbsp;fieldNumber)</code>
<div class="block">Fetch one field from the field manager.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchIntField-int-">fetchIntField</a></span>(int&nbsp;fieldNumber)</code>
<div class="block">Fetch one field from the field manager.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchLongField-int-">fetchLongField</a></span>(int&nbsp;fieldNumber)</code>
<div class="block">Fetch one field from the field manager.</div>
</td>
</tr>
<tr id="i7" 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/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchObjectField-int-">fetchObjectField</a></span>(int&nbsp;fieldNumber)</code>
<div class="block">Fetch one field from the field manager.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchShortField-int-">fetchShortField</a></span>(int&nbsp;fieldNumber)</code>
<div class="block">Fetch one field from the field manager.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchStringField-int-">fetchStringField</a></span>(int&nbsp;fieldNumber)</code>
<div class="block">Fetch one field from the field manager.</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="fetchBooleanField-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchBooleanField</h4>
<pre>boolean&nbsp;fetchBooleanField(int&nbsp;fieldNumber)</pre>
<div class="block">Fetch one field from the field manager. This field will be stored in the
proper field of the ObjectId.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldNumber</code> - the field number of the key field.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the field to be stored into the ObjectId.</dd>
</dl>
</li>
</ul>
<a name="fetchCharField-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchCharField</h4>
<pre>char&nbsp;fetchCharField(int&nbsp;fieldNumber)</pre>
<div class="block">Fetch one field from the field manager. This field will be stored in the
proper field of the ObjectId.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldNumber</code> - the field number of the key field.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the field to be stored into the ObjectId.</dd>
</dl>
</li>
</ul>
<a name="fetchByteField-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchByteField</h4>
<pre>byte&nbsp;fetchByteField(int&nbsp;fieldNumber)</pre>
<div class="block">Fetch one field from the field manager. This field will be stored in the
proper field of the ObjectId.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldNumber</code> - the field number of the key field.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the field to be stored into the ObjectId.</dd>
</dl>
</li>
</ul>
<a name="fetchShortField-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchShortField</h4>
<pre>short&nbsp;fetchShortField(int&nbsp;fieldNumber)</pre>
<div class="block">Fetch one field from the field manager. This field will be stored in the
proper field of the ObjectId.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldNumber</code> - the field number of the key field.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the field to be stored into the ObjectId.</dd>
</dl>
</li>
</ul>
<a name="fetchIntField-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchIntField</h4>
<pre>int&nbsp;fetchIntField(int&nbsp;fieldNumber)</pre>
<div class="block">Fetch one field from the field manager. This field will be stored in the
proper field of the ObjectId.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldNumber</code> - the field number of the key field.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the field to be stored into the ObjectId.</dd>
</dl>
</li>
</ul>
<a name="fetchLongField-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchLongField</h4>
<pre>long&nbsp;fetchLongField(int&nbsp;fieldNumber)</pre>
<div class="block">Fetch one field from the field manager. This field will be stored in the
proper field of the ObjectId.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldNumber</code> - the field number of the key field.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the field to be stored into the ObjectId.</dd>
</dl>
</li>
</ul>
<a name="fetchFloatField-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchFloatField</h4>
<pre>float&nbsp;fetchFloatField(int&nbsp;fieldNumber)</pre>
<div class="block">Fetch one field from the field manager. This field will be stored in the
proper field of the ObjectId.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldNumber</code> - the field number of the key field.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the field to be stored into the ObjectId.</dd>
</dl>
</li>
</ul>
<a name="fetchDoubleField-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchDoubleField</h4>
<pre>double&nbsp;fetchDoubleField(int&nbsp;fieldNumber)</pre>
<div class="block">Fetch one field from the field manager. This field will be stored in the
proper field of the ObjectId.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldNumber</code> - the field number of the key field.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the field to be stored into the ObjectId.</dd>
</dl>
</li>
</ul>
<a name="fetchStringField-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchStringField</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fetchStringField(int&nbsp;fieldNumber)</pre>
<div class="block">Fetch one field from the field manager. This field will be stored in the
proper field of the ObjectId.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldNumber</code> - the field number of the key field.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the field to be stored into the ObjectId.</dd>
</dl>
</li>
</ul>
<a name="fetchObjectField-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fetchObjectField</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;fetchObjectField(int&nbsp;fieldNumber)</pre>
<div class="block">Fetch one field from the field manager. This field will be stored in the
proper field of the ObjectId.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldNumber</code> - the field number of the key field.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the field to be stored into the ObjectId.</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/PersistenceCapable.ObjectIdFieldSupplier.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/spi/PersistenceCapable.ObjectIdFieldManager.html" title="interface in javax.jdo.spi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/jdo/spi/RegisterClassEvent.html" title="class in javax.jdo.spi"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html" target="_top">Frames</a></li>
<li><a href="PersistenceCapable.ObjectIdFieldSupplier.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2005&#x2013;2022 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>