| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_18) on Fri May 21 07:02:03 BST 2010 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| PersistenceCapable.ObjectIdFieldSupplier (JDO API 3.0) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2010-05-21"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PersistenceCapable.ObjectIdFieldSupplier (JDO API 3.0)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PersistenceCapable.ObjectIdFieldSupplier.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldManager.html" title="interface in javax.jdo.spi"><B>PREV CLASS</B></A> |
| <A HREF="../../../javax/jdo/spi/RegisterClassEvent.html" title="class in javax.jdo.spi"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="PersistenceCapable.ObjectIdFieldSupplier.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| javax.jdo.spi</FONT> |
| <BR> |
| Interface PersistenceCapable.ObjectIdFieldSupplier</H2> |
| <DL> |
| <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldManager.html" title="interface in javax.jdo.spi">PersistenceCapable.ObjectIdFieldManager</A></DD> |
| </DL> |
| <DL> |
| <DT><B>Enclosing interface:</B><DD><A HREF="../../../javax/jdo/spi/PersistenceCapable.html" title="interface in javax.jdo.spi">PersistenceCapable</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public static interface <B>PersistenceCapable.ObjectIdFieldSupplier</B></DL> |
| </PRE> |
| |
| <P> |
| 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. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchBooleanField(int)">fetchBooleanField</A></B>(int fieldNumber)</CODE> |
| |
| <BR> |
| Fetch one field from the field manager.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> byte</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchByteField(int)">fetchByteField</A></B>(int fieldNumber)</CODE> |
| |
| <BR> |
| Fetch one field from the field manager.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> char</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchCharField(int)">fetchCharField</A></B>(int fieldNumber)</CODE> |
| |
| <BR> |
| Fetch one field from the field manager.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> double</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchDoubleField(int)">fetchDoubleField</A></B>(int fieldNumber)</CODE> |
| |
| <BR> |
| Fetch one field from the field manager.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> float</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchFloatField(int)">fetchFloatField</A></B>(int fieldNumber)</CODE> |
| |
| <BR> |
| Fetch one field from the field manager.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchIntField(int)">fetchIntField</A></B>(int fieldNumber)</CODE> |
| |
| <BR> |
| Fetch one field from the field manager.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchLongField(int)">fetchLongField</A></B>(int fieldNumber)</CODE> |
| |
| <BR> |
| Fetch one field from the field manager.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchObjectField(int)">fetchObjectField</A></B>(int fieldNumber)</CODE> |
| |
| <BR> |
| Fetch one field from the field manager.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> short</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchShortField(int)">fetchShortField</A></B>(int fieldNumber)</CODE> |
| |
| <BR> |
| Fetch one field from the field manager.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html#fetchStringField(int)">fetchStringField</A></B>(int fieldNumber)</CODE> |
| |
| <BR> |
| Fetch one field from the field manager.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="fetchBooleanField(int)"><!-- --></A><H3> |
| fetchBooleanField</H3> |
| <PRE> |
| boolean <B>fetchBooleanField</B>(int fieldNumber)</PRE> |
| <DL> |
| <DD>Fetch one field from the field manager. This field will be stored in the |
| proper field of the ObjectId. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field. |
| <DT><B>Returns:</B><DD>the value of the field to be stored into the ObjectId.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="fetchCharField(int)"><!-- --></A><H3> |
| fetchCharField</H3> |
| <PRE> |
| char <B>fetchCharField</B>(int fieldNumber)</PRE> |
| <DL> |
| <DD>Fetch one field from the field manager. This field will be stored in the |
| proper field of the ObjectId. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field. |
| <DT><B>Returns:</B><DD>the value of the field to be stored into the ObjectId.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="fetchByteField(int)"><!-- --></A><H3> |
| fetchByteField</H3> |
| <PRE> |
| byte <B>fetchByteField</B>(int fieldNumber)</PRE> |
| <DL> |
| <DD>Fetch one field from the field manager. This field will be stored in the |
| proper field of the ObjectId. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field. |
| <DT><B>Returns:</B><DD>the value of the field to be stored into the ObjectId.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="fetchShortField(int)"><!-- --></A><H3> |
| fetchShortField</H3> |
| <PRE> |
| short <B>fetchShortField</B>(int fieldNumber)</PRE> |
| <DL> |
| <DD>Fetch one field from the field manager. This field will be stored in the |
| proper field of the ObjectId. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field. |
| <DT><B>Returns:</B><DD>the value of the field to be stored into the ObjectId.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="fetchIntField(int)"><!-- --></A><H3> |
| fetchIntField</H3> |
| <PRE> |
| int <B>fetchIntField</B>(int fieldNumber)</PRE> |
| <DL> |
| <DD>Fetch one field from the field manager. This field will be stored in the |
| proper field of the ObjectId. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field. |
| <DT><B>Returns:</B><DD>the value of the field to be stored into the ObjectId.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="fetchLongField(int)"><!-- --></A><H3> |
| fetchLongField</H3> |
| <PRE> |
| long <B>fetchLongField</B>(int fieldNumber)</PRE> |
| <DL> |
| <DD>Fetch one field from the field manager. This field will be stored in the |
| proper field of the ObjectId. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field. |
| <DT><B>Returns:</B><DD>the value of the field to be stored into the ObjectId.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="fetchFloatField(int)"><!-- --></A><H3> |
| fetchFloatField</H3> |
| <PRE> |
| float <B>fetchFloatField</B>(int fieldNumber)</PRE> |
| <DL> |
| <DD>Fetch one field from the field manager. This field will be stored in the |
| proper field of the ObjectId. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field. |
| <DT><B>Returns:</B><DD>the value of the field to be stored into the ObjectId.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="fetchDoubleField(int)"><!-- --></A><H3> |
| fetchDoubleField</H3> |
| <PRE> |
| double <B>fetchDoubleField</B>(int fieldNumber)</PRE> |
| <DL> |
| <DD>Fetch one field from the field manager. This field will be stored in the |
| proper field of the ObjectId. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field. |
| <DT><B>Returns:</B><DD>the value of the field to be stored into the ObjectId.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="fetchStringField(int)"><!-- --></A><H3> |
| fetchStringField</H3> |
| <PRE> |
| java.lang.String <B>fetchStringField</B>(int fieldNumber)</PRE> |
| <DL> |
| <DD>Fetch one field from the field manager. This field will be stored in the |
| proper field of the ObjectId. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field. |
| <DT><B>Returns:</B><DD>the value of the field to be stored into the ObjectId.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="fetchObjectField(int)"><!-- --></A><H3> |
| fetchObjectField</H3> |
| <PRE> |
| java.lang.Object <B>fetchObjectField</B>(int fieldNumber)</PRE> |
| <DL> |
| <DD>Fetch one field from the field manager. This field will be stored in the |
| proper field of the ObjectId. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fieldNumber</CODE> - the field number of the key field. |
| <DT><B>Returns:</B><DD>the value of the field to be stored into the ObjectId.</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PersistenceCapable.ObjectIdFieldSupplier.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../javax/jdo/spi/PersistenceCapable.ObjectIdFieldManager.html" title="interface in javax.jdo.spi"><B>PREV CLASS</B></A> |
| <A HREF="../../../javax/jdo/spi/RegisterClassEvent.html" title="class in javax.jdo.spi"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?javax/jdo/spi/PersistenceCapable.ObjectIdFieldSupplier.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="PersistenceCapable.ObjectIdFieldSupplier.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2005-2010 Apache Software Foundation. All Rights Reserved. |
| </BODY> |
| </HTML> |
