1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_03) on Mon Apr 12 16:25:47 EDT 2010 --> 6<TITLE> 7SecondaryCursor (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="date" CONTENT="2010-04-12"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 if (location.href.indexOf('is-external=true') == -1) { 18 parent.document.title="SecondaryCursor (Oracle - Berkeley DB Java API)"; 19 } 20} 21</SCRIPT> 22<NOSCRIPT> 23</NOSCRIPT> 24 25</HEAD> 26 27<BODY BGCOLOR="white" onload="windowTitle();"> 28<HR> 29 30 31<!-- ========= START OF TOP NAVBAR ======= --> 32<A NAME="navbar_top"><!-- --></A> 33<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 35<TR> 36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 37<A NAME="navbar_top_firstrow"><!-- --></A> 38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 39 <TR ALIGN="center" VALIGN="top"> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SecondaryCursor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 48 </TR> 49</TABLE> 50</TD> 51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 52<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 53</TD> 54</TR> 55 56<TR> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> 59 <A HREF="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../index.html?com/sleepycat/db/SecondaryCursor.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="SecondaryCursor.html" target="_top"><B>NO FRAMES</B></A> 63 <SCRIPT type="text/javascript"> 64 <!-- 65 if(window==top) { 66 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 67 } 68 //--> 69</SCRIPT> 70<NOSCRIPT> 71 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 72</NOSCRIPT> 73 74 75</FONT></TD> 76</TR> 77<TR> 78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 79 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 82</TR> 83</TABLE> 84<A NAME="skip-navbar_top"></A> 85<!-- ========= END OF TOP NAVBAR ========= --> 86 87<HR> 88<!-- ======== START OF CLASS DATA ======== --> 89<H2> 90<FONT SIZE="-1"> 91com.sleepycat.db</FONT> 92<BR> 93Class SecondaryCursor</H2> 94<PRE> 95<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> 96 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">com.sleepycat.db.Cursor</A> 97 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.SecondaryCursor</B> 98</PRE> 99<HR> 100<DL> 101<DT><PRE>public class <B>SecondaryCursor</B><DT>extends <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</A></DL> 102</PRE> 103 104<P> 105A database cursor for a secondary database. Cursors are not thread safe 106and the application is responsible for coordinating any multithreaded 107access to a single cursor object. 108<p> 109Secondary cursors are returned by 110<A HREF="../../../com/sleepycat/db/SecondaryDatabase.html#openCursor(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)"><CODE>SecondaryDatabase.openCursor</CODE></A> and 111<A HREF="../../../com/sleepycat/db/SecondaryDatabase.html#openSecondaryCursor(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)"><CODE>SecondaryDatabase.openSecondaryCursor</CODE></A>. The distinguishing characteristics 112of a secondary cursor are: 113<ul> 114<li>Direct calls to <code>put()</code> methods on a secondary cursor are 115prohibited. 116<li>The <A HREF="../../../com/sleepycat/db/Cursor.html#delete()"><CODE>Cursor.delete()</CODE></A> method of a secondary cursor will delete the primary 117record and as well as all its associated secondary records. 118<li>Calls to all get methods will return the data from the associated 119primary database. 120<li>Additional get method signatures are provided to return the primary key 121in an additional pKey parameter. 122<li>Calls to <A HREF="../../../com/sleepycat/db/SecondaryCursor.html#dup(boolean)"><CODE>dup(boolean)</CODE></A> will return a <A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><CODE>SecondaryCursor</CODE></A>. 123<li>The <A HREF="../../../com/sleepycat/db/SecondaryCursor.html#dupSecondary(boolean)"><CODE>dupSecondary(boolean)</CODE></A> method is provided to return a <A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><CODE>SecondaryCursor</CODE></A> that doesn't require casting. 124</ul> 125<p> 126To obtain a secondary cursor with default attributes: 127<blockquote><pre> 128 SecondaryCursor cursor = myDb.openSecondaryCursor(txn, null); 129</pre></blockquote> 130To customize the attributes of a cursor, use a CursorConfig object. 131<blockquote><pre> 132 CursorConfig config = new CursorConfig(); 133 config.setDirtyRead(true); 134 SecondaryCursor cursor = myDb.openSecondaryCursor(txn, config); 135</pre></blockquote> 136<P> 137 138<P> 139<HR> 140 141<P> 142 143<!-- ========== METHOD SUMMARY =========== --> 144 145<A NAME="method_summary"><!-- --></A> 146<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 147<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 148<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 149<B>Method Summary</B></FONT></TH> 150</TR> 151<TR BGCOLOR="white" CLASS="TableRowColor"> 152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 153<CODE> <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</A></CODE></FONT></TD> 154<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#dup(boolean)">dup</A></B>(boolean samePosition)</CODE> 155 156<BR> 157 Returns a new <code>SecondaryCursor</code> for the same transaction as 158 the original cursor.</TD> 159</TR> 160<TR BGCOLOR="white" CLASS="TableRowColor"> 161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 162<CODE> <A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db">SecondaryCursor</A></CODE></FONT></TD> 163<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#dupSecondary(boolean)">dupSecondary</A></B>(boolean samePosition)</CODE> 164 165<BR> 166 Returns a new copy of the cursor as a <code>SecondaryCursor</code>.</TD> 167</TR> 168<TR BGCOLOR="white" CLASS="TableRowColor"> 169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 170<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> 171<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#getCurrent(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getCurrent</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 172 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 173 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 174 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 175 176<BR> 177 Returns the key/data pair to which the cursor refers.</TD> 178</TR> 179<TR BGCOLOR="white" CLASS="TableRowColor"> 180<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 181<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> 182<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#getFirst(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getFirst</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 183 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 184 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 185 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 186 187<BR> 188 Move the cursor to the first key/data pair of the database, and return 189that pair.</TD> 190</TR> 191<TR BGCOLOR="white" CLASS="TableRowColor"> 192<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 193<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> 194<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#getLast(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getLast</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 195 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 196 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 197 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 198 199<BR> 200 Move the cursor to the last key/data pair of the database, and return 201that pair.</TD> 202</TR> 203<TR BGCOLOR="white" CLASS="TableRowColor"> 204<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 205<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> 206<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#getNext(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getNext</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 207 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 208 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 209 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 210 211<BR> 212 Move the cursor to the next key/data pair and return that pair.</TD> 213</TR> 214<TR BGCOLOR="white" CLASS="TableRowColor"> 215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 216<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> 217<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#getNextDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getNextDup</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 218 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 219 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 220 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 221 222<BR> 223 If the next key/data pair of the database is a duplicate data record for 224the current key/data pair, move the cursor to the next key/data pair 225of the database and return that pair.</TD> 226</TR> 227<TR BGCOLOR="white" CLASS="TableRowColor"> 228<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 229<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> 230<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#getNextNoDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getNextNoDup</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 231 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 232 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 233 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 234 235<BR> 236 Move the cursor to the next non-duplicate key/data pair and return 237that pair.</TD> 238</TR> 239<TR BGCOLOR="white" CLASS="TableRowColor"> 240<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 241<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> 242<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#getPrev(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getPrev</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 243 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 244 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 245 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 246 247<BR> 248 Move the cursor to the previous key/data pair and return that pair.</TD> 249</TR> 250<TR BGCOLOR="white" CLASS="TableRowColor"> 251<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 252<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> 253<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#getPrevDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getPrevDup</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 254 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 255 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 256 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 257 258<BR> 259 If the previous key/data pair of the database is a duplicate data record 260for the current key/data pair, move the cursor to the previous key/data 261pair of the database and return that pair.</TD> 262</TR> 263<TR BGCOLOR="white" CLASS="TableRowColor"> 264<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 265<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> 266<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#getPrevNoDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getPrevNoDup</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 267 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 268 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 269 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 270 271<BR> 272 Move the cursor to the previous non-duplicate key/data pair and return 273that pair.</TD> 274</TR> 275<TR BGCOLOR="white" CLASS="TableRowColor"> 276<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 277<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> 278<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#getRecordNumber(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getRecordNumber</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> secondaryRecno, 279 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> primaryRecno, 280 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 281 282<BR> 283 Return the record number associated with the cursor.</TD> 284</TR> 285<TR BGCOLOR="white" CLASS="TableRowColor"> 286<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 287<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> 288<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#getSearchBoth(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchBoth</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 289 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 290 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 291 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 292 293<BR> 294 Move the cursor to the specified secondary and primary key, where both 295the primary and secondary key items must match.</TD> 296</TR> 297<TR BGCOLOR="white" CLASS="TableRowColor"> 298<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 299<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> 300<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#getSearchBothRange(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchBothRange</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 301 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 302 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 303 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 304 305<BR> 306 Move the cursor to the specified secondary key and closest matching primary 307key of the database.</TD> 308</TR> 309<TR BGCOLOR="white" CLASS="TableRowColor"> 310<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 311<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> 312<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#getSearchKey(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchKey</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 313 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 314 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 315 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 316 317<BR> 318 Move the cursor to the given key of the database, and return the datum 319associated with the given key.</TD> 320</TR> 321<TR BGCOLOR="white" CLASS="TableRowColor"> 322<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 323<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> 324<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#getSearchKeyRange(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchKeyRange</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 325 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 326 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 327 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 328 329<BR> 330 Move the cursor to the closest matching key of the database, and return 331the data item associated with the matching key.</TD> 332</TR> 333<TR BGCOLOR="white" CLASS="TableRowColor"> 334<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 335<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> 336<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#getSearchRecordNumber(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchRecordNumber</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> secondaryRecno, 337 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 338 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 339 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 340 341<BR> 342 Move the cursor to the specific numbered record of the database, and 343return the associated key/data pair.</TD> 344</TR> 345<TR BGCOLOR="white" CLASS="TableRowColor"> 346<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 347<CODE> <A HREF="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</A></CODE></FONT></TD> 348<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#getSecondaryDatabase()">getSecondaryDatabase</A></B>()</CODE> 349 350<BR> 351 Return the SecondaryDatabase handle associated with this Cursor.</TD> 352</TR> 353</TABLE> 354 <A NAME="methods_inherited_from_class_com.sleepycat.db.Cursor"><!-- --></A> 355<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 356<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 357<TH ALIGN="left"><B>Methods inherited from class com.sleepycat.db.<A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</A></B></TH> 358</TR> 359<TR BGCOLOR="white" CLASS="TableRowColor"> 360<TD><CODE><A HREF="../../../com/sleepycat/db/Cursor.html#close()">close</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#compare(com.sleepycat.db.Cursor)">compare</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#count()">count</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#delete()">delete</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getConfig()">getConfig</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getCurrent(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getCurrent</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getDatabase()">getDatabase</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getFirst(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getFirst</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getLast(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getLast</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getNext(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getNext</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getNextDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getNextDup</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getNextNoDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getNextNoDup</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getPrev(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getPrev</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getPrevDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getPrevDup</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getPrevNoDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getPrevNoDup</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getPriority()">getPriority</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getRecordNumber(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getRecordNumber</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getSearchBoth(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchBoth</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getSearchBothRange(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchBothRange</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getSearchKey(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchKey</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getSearchKeyRange(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchKeyRange</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#getSearchRecordNumber(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchRecordNumber</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#put(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">put</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#putAfter(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putAfter</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#putBefore(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putBefore</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#putCurrent(com.sleepycat.db.DatabaseEntry)">putCurrent</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#putKeyFirst(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putKeyFirst</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#putKeyLast(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putKeyLast</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#putNoDupData(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putNoDupData</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#putNoOverwrite(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putNoOverwrite</A>, <A HREF="../../../com/sleepycat/db/Cursor.html#setPriority(com.sleepycat.db.CacheFilePriority)">setPriority</A></CODE></TD> 361</TR> 362</TABLE> 363 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 364<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 365<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 366<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> 367</TR> 368<TR BGCOLOR="white" CLASS="TableRowColor"> 369<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 370</TR> 371</TABLE> 372 373<P> 374 375<!-- ============ METHOD DETAIL ========== --> 376 377<A NAME="method_detail"><!-- --></A> 378<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 379<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 380<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 381<B>Method Detail</B></FONT></TH> 382</TR> 383</TABLE> 384 385<A NAME="getSecondaryDatabase()"><!-- --></A><H3> 386getSecondaryDatabase</H3> 387<PRE> 388public <A HREF="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</A> <B>getSecondaryDatabase</B>()</PRE> 389<DL> 390<DD>Return the SecondaryDatabase handle associated with this Cursor. 391 <p> 392<P> 393<DD><DL> 394 395<DT><B>Returns:</B><DD>The SecondaryDatabase handle associated with this Cursor. 396 <p></DL> 397</DD> 398</DL> 399<HR> 400 401<A NAME="dup(boolean)"><!-- --></A><H3> 402dup</H3> 403<PRE> 404public <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</A> <B>dup</B>(boolean samePosition) 405 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 406<DL> 407<DD>Returns a new <code>SecondaryCursor</code> for the same transaction as 408 the original cursor. 409<P> 410<DD><DL> 411<DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/sleepycat/db/Cursor.html#dup(boolean)">dup</A></CODE> in class <CODE><A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</A></CODE></DL> 412</DD> 413<DD><DL> 414<DT><B>Parameters:</B><DD><CODE>samePosition</CODE> - If true, the newly created cursor is initialized to refer to the 415 same position in the database as the original cursor (if any) and 416 hold the same locks (if any). If false, or the original cursor does 417 not hold a database position and locks, the returned cursor is 418 uninitialized and will behave like a newly created cursor. 419 <p> 420<DT><B>Returns:</B><DD>A new cursor with the same transaction and locker ID as the original 421 cursor. 422 <p> 423 <p> 424<DT><B>Throws:</B> 425<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 426</DD> 427</DL> 428<HR> 429 430<A NAME="dupSecondary(boolean)"><!-- --></A><H3> 431dupSecondary</H3> 432<PRE> 433public <A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db">SecondaryCursor</A> <B>dupSecondary</B>(boolean samePosition) 434 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 435<DL> 436<DD>Returns a new copy of the cursor as a <code>SecondaryCursor</code>. 437 <p> 438 Calling this method is the equivalent of calling <A HREF="../../../com/sleepycat/db/SecondaryCursor.html#dup(boolean)"><CODE>dup(boolean)</CODE></A> and 439 casting the result to <A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><CODE>SecondaryCursor</CODE></A>. 440 <p> 441<P> 442<DD><DL> 443 444<DT><B>Throws:</B> 445<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/SecondaryCursor.html#dup(boolean)"><CODE>dup(boolean)</CODE></A></DL> 446</DD> 447</DL> 448<HR> 449 450<A NAME="getCurrent(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> 451getCurrent</H3> 452<PRE> 453public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getCurrent</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 454 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 455 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 456 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 457 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 458<DL> 459<DD>Returns the key/data pair to which the cursor refers. 460<p> 461If this method fails for any reason, the position of the cursor will be 462unchanged. 463<P> 464<DD><DL> 465<DT><B>Parameters:</B><DD><CODE>key</CODE> - the secondary key 466returned as output. Its byte array does not need to be initialized by the 467caller.<DD><CODE>pKey</CODE> - the primary key 468returned as output. Its byte array does not need to be initialized by the 469caller.<DD><CODE>data</CODE> - the primary data 470returned as output. Multiple results can be retrieved by passing an object 471that is a subclass of <A HREF="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db"><CODE>MultipleEntry</CODE></A>, otherwise its byte array does not 472need to be initialized by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. 473<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A> if the key/pair at the cursor 474position has been deleted; otherwise, <A HREF="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. 475<DT><B>Throws:</B> 476<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or 477does not contain a required non-null byte array. 478<p> 479<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 480deadlock. 481<p> 482<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 483<p> 484<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 485<p></DL> 486</DD> 487</DL> 488<HR> 489 490<A NAME="getFirst(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> 491getFirst</H3> 492<PRE> 493public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getFirst</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 494 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 495 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 496 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 497 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 498<DL> 499<DD>Move the cursor to the first key/data pair of the database, and return 500that pair. If the first key has duplicate values, the first data item 501in the set of duplicates is returned. 502<p> 503If this method fails for any reason, the position of the cursor will be 504unchanged. 505<P> 506<DD><DL> 507<DT><B>Parameters:</B><DD><CODE>key</CODE> - the secondary key 508returned as output. Its byte array does not need to be initialized by the 509caller.<DD><CODE>pKey</CODE> - the primary key 510returned as output. Its byte array does not need to be initialized by the 511caller.<DD><CODE>data</CODE> - the primary data 512returned as output. Multiple results can be retrieved by passing an object 513that is a subclass of <A HREF="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db"><CODE>MultipleEntry</CODE></A>, otherwise its byte array does not 514need to be initialized by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. 515<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is 516found; <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <A HREF="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. 517<DT><B>Throws:</B> 518<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or 519does not contain a required non-null byte array. 520<p> 521<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 522deadlock. 523<p> 524<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 525<p> 526<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 527<p></DL> 528</DD> 529</DL> 530<HR> 531 532<A NAME="getLast(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> 533getLast</H3> 534<PRE> 535public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getLast</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 536 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 537 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 538 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 539 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 540<DL> 541<DD>Move the cursor to the last key/data pair of the database, and return 542that pair. If the last key has duplicate values, the last data item in 543the set of duplicates is returned. 544<p> 545If this method fails for any reason, the position of the cursor will be 546unchanged. 547<P> 548<DD><DL> 549<DT><B>Parameters:</B><DD><CODE>key</CODE> - the secondary key 550returned as output. Its byte array does not need to be initialized by the 551caller.<DD><CODE>pKey</CODE> - the primary key 552returned as output. Its byte array does not need to be initialized by the 553caller.<DD><CODE>data</CODE> - the primary data 554returned as output. Its byte array does not need to be initialized by the 555caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. 556<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is 557found; <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <A HREF="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. 558<DT><B>Throws:</B> 559<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or 560does not contain a required non-null byte array. 561<p> 562<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 563deadlock. 564<p> 565<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 566<p> 567<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 568<p></DL> 569</DD> 570</DL> 571<HR> 572 573<A NAME="getNext(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> 574getNext</H3> 575<PRE> 576public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getNext</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 577 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 578 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 579 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 580 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 581<DL> 582<DD>Move the cursor to the next key/data pair and return that pair. If 583the matching key has duplicate values, the first data item in the set 584of duplicates is returned. 585<p> 586If the cursor is not yet initialized, move the cursor to the first 587key/data pair of the database, and return that pair. Otherwise, the 588cursor is moved to the next key/data pair of the database, and that pair 589is returned. In the presence of duplicate key values, the value of the 590key may not change. 591<p> 592If this method fails for any reason, the position of the cursor will be 593unchanged. 594<P> 595<DD><DL> 596<DT><B>Parameters:</B><DD><CODE>key</CODE> - the secondary key 597returned as output. Its byte array does not need to be initialized by the 598caller.<DD><CODE>pKey</CODE> - the primary key 599returned as output. Its byte array does not need to be initialized by the 600caller.<DD><CODE>data</CODE> - the primary data 601returned as output. Multiple results can be retrieved by passing an object 602that is a subclass of <A HREF="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db"><CODE>MultipleEntry</CODE></A>, otherwise its byte array does not 603need to be initialized by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. 604<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is 605found; <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <A HREF="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. 606<DT><B>Throws:</B> 607<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or 608does not contain a required non-null byte array. 609<p> 610<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 611deadlock. 612<p> 613<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 614<p> 615<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 616<p></DL> 617</DD> 618</DL> 619<HR> 620 621<A NAME="getNextDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> 622getNextDup</H3> 623<PRE> 624public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getNextDup</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 625 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 626 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 627 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 628 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 629<DL> 630<DD>If the next key/data pair of the database is a duplicate data record for 631the current key/data pair, move the cursor to the next key/data pair 632of the database and return that pair. 633<p> 634If this method fails for any reason, the position of the cursor will be 635unchanged. 636<P> 637<DD><DL> 638<DT><B>Parameters:</B><DD><CODE>key</CODE> - the secondary key 639returned as output. Its byte array does not need to be initialized by the 640caller.<DD><CODE>pKey</CODE> - the primary key 641returned as output. Its byte array does not need to be initialized by the 642caller.<DD><CODE>data</CODE> - the primary data 643returned as output. Multiple results can be retrieved by passing an object 644that is a subclass of <A HREF="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db"><CODE>MultipleEntry</CODE></A>, otherwise its byte array does not 645need to be initialized by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. 646<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is 647found; <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <A HREF="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. 648<DT><B>Throws:</B> 649<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or 650does not contain a required non-null byte array. 651<p> 652<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 653deadlock. 654<p> 655<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 656<p> 657<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 658<p></DL> 659</DD> 660</DL> 661<HR> 662 663<A NAME="getNextNoDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> 664getNextNoDup</H3> 665<PRE> 666public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getNextNoDup</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 667 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 668 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 669 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 670 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 671<DL> 672<DD>Move the cursor to the next non-duplicate key/data pair and return 673that pair. If the matching key has duplicate values, the first data 674item in the set of duplicates is returned. 675<p> 676If the cursor is not yet initialized, move the cursor to the first 677key/data pair of the database, and return that pair. Otherwise, the 678cursor is moved to the next non-duplicate key of the database, and that 679key/data pair is returned. 680<p> 681If this method fails for any reason, the position of the cursor will be 682unchanged. 683<P> 684<DD><DL> 685<DT><B>Parameters:</B><DD><CODE>key</CODE> - the secondary key 686returned as output. Its byte array does not need to be initialized by the 687caller.<DD><CODE>pKey</CODE> - the primary key 688returned as output. Its byte array does not need to be initialized by the 689caller.<DD><CODE>data</CODE> - the primary data 690returned as output. Multiple results can be retrieved by passing an object 691that is a subclass of <A HREF="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db"><CODE>MultipleEntry</CODE></A>, otherwise its byte array does not 692need to be initialized by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. 693<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is 694found; <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <A HREF="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. 695<DT><B>Throws:</B> 696<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or 697does not contain a required non-null byte array. 698<p> 699<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 700deadlock. 701<p> 702<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 703<p> 704<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 705<p></DL> 706</DD> 707</DL> 708<HR> 709 710<A NAME="getPrev(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> 711getPrev</H3> 712<PRE> 713public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getPrev</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 714 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 715 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 716 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 717 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 718<DL> 719<DD>Move the cursor to the previous key/data pair and return that pair. 720If the matching key has duplicate values, the last data item in the set 721of duplicates is returned. 722<p> 723If the cursor is not yet initialized, move the cursor to the last 724key/data pair of the database, and return that pair. Otherwise, the 725cursor is moved to the previous key/data pair of the database, and that 726pair is returned. In the presence of duplicate key values, the value of 727the key may not change. 728<p> 729If this method fails for any reason, the position of the cursor will be 730unchanged. 731<P> 732<DD><DL> 733<DT><B>Parameters:</B><DD><CODE>key</CODE> - the secondary key 734returned as output. Its byte array does not need to be initialized by the 735caller.<DD><CODE>pKey</CODE> - the primary key 736returned as output. Its byte array does not need to be initialized by the 737caller.<DD><CODE>data</CODE> - the primary data 738returned as output. Its byte array does not need to be initialized by the 739caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. 740<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is 741found; <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <A HREF="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. 742<DT><B>Throws:</B> 743<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or 744does not contain a required non-null byte array. 745<p> 746<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 747deadlock. 748<p> 749<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 750<p> 751<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 752<p></DL> 753</DD> 754</DL> 755<HR> 756 757<A NAME="getPrevDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> 758getPrevDup</H3> 759<PRE> 760public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getPrevDup</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 761 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 762 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 763 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 764 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 765<DL> 766<DD>If the previous key/data pair of the database is a duplicate data record 767for the current key/data pair, move the cursor to the previous key/data 768pair of the database and return that pair. 769<p> 770If this method fails for any reason, the position of the cursor will be 771unchanged. 772<P> 773<DD><DL> 774<DT><B>Parameters:</B><DD><CODE>key</CODE> - the secondary key 775returned as output. Its byte array does not need to be initialized by the 776caller.<DD><CODE>pKey</CODE> - the primary key 777returned as output. Its byte array does not need to be initialized by the 778caller.<DD><CODE>data</CODE> - the primary data 779returned as output. Its byte array does not need to be initialized by the 780caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. 781<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is 782found; <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <A HREF="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. 783<DT><B>Throws:</B> 784<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or 785does not contain a required non-null byte array. 786<p> 787<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 788deadlock. 789<p> 790<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 791<p> 792<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 793<p></DL> 794</DD> 795</DL> 796<HR> 797 798<A NAME="getPrevNoDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> 799getPrevNoDup</H3> 800<PRE> 801public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getPrevNoDup</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 802 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 803 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 804 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 805 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 806<DL> 807<DD>Move the cursor to the previous non-duplicate key/data pair and return 808that pair. If the matching key has duplicate values, the last data item 809in the set of duplicates is returned. 810<p> 811If the cursor is not yet initialized, move the cursor to the last 812key/data pair of the database, and return that pair. Otherwise, the 813cursor is moved to the previous non-duplicate key of the database, and 814that key/data pair is returned. 815<p> 816If this method fails for any reason, the position of the cursor will be 817unchanged. 818<P> 819<DD><DL> 820<DT><B>Parameters:</B><DD><CODE>key</CODE> - the secondary key 821returned as output. Its byte array does not need to be initialized by the 822caller.<DD><CODE>pKey</CODE> - the primary key 823returned as output. Its byte array does not need to be initialized by the 824caller.<DD><CODE>data</CODE> - the primary data 825returned as output. Its byte array does not need to be initialized by the 826caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. 827<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is 828found; <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <A HREF="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. 829<DT><B>Throws:</B> 830<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or 831does not contain a required non-null byte array. 832<p> 833<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 834deadlock. 835<p> 836<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 837<p> 838<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 839<p></DL> 840</DD> 841</DL> 842<HR> 843 844<A NAME="getRecordNumber(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> 845getRecordNumber</H3> 846<PRE> 847public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getRecordNumber</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> secondaryRecno, 848 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> primaryRecno, 849 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 850 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 851<DL> 852<DD>Return the record number associated with the cursor. The record number 853will be returned in the data parameter. 854<p> 855For this method to be called, the underlying database must be of type 856Btree, and it must have been configured to support record numbers. 857<p> 858When called on a cursor opened on a database that has been made into a 859secondary index, the method returns the record numbers of both the 860secondary and primary databases. If either underlying database is not of 861type Btree or is not configured with record numbers, the out-of-band 862record number of 0 is returned. 863<p> 864If this method fails for any reason, the position of the cursor will be 865unchanged. 866<P> 867<DD><DL> 868<DT><B>Parameters:</B><DD><CODE>secondaryRecno</CODE> - the secondary record number 869returned as output. Its byte array does not need to be initialized by the 870caller.<DD><CODE>primaryRecno</CODE> - the primary record number 871returned as output. Its byte array does not need to be initialized by the 872caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. 873<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is 874found; <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <A HREF="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. 875<DT><B>Throws:</B> 876<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or 877does not contain a required non-null byte array. 878<p> 879<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 880deadlock. 881<p> 882<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 883<p> 884<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 885<p></DL> 886</DD> 887</DL> 888<HR> 889 890<A NAME="getSearchKey(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> 891getSearchKey</H3> 892<PRE> 893public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getSearchKey</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 894 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 895 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 896 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 897 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 898<DL> 899<DD>Move the cursor to the given key of the database, and return the datum 900associated with the given key. If the matching key has duplicate 901values, the first data item in the set of duplicates is returned. 902<p> 903If this method fails for any reason, the position of the cursor will be 904unchanged. 905<P> 906<DD><DL> 907<DT><B>Parameters:</B><DD><CODE>key</CODE> - the secondary key 908used as input. It must be initialized with a non-null byte array by the 909caller.<DD><CODE>pKey</CODE> - the primary key 910returned as output. Its byte array does not need to be initialized by the 911caller.<DD><CODE>data</CODE> - the primary data 912returned as output. Multiple results can be retrieved by passing an object 913that is a subclass of <A HREF="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db"><CODE>MultipleEntry</CODE></A>, otherwise its byte array does not 914need to be initialized by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. 915<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is 916found; <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <A HREF="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. 917<DT><B>Throws:</B> 918<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or 919does not contain a required non-null byte array. 920<p> 921<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 922deadlock. 923<p> 924<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 925<p> 926<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 927<p></DL> 928</DD> 929</DL> 930<HR> 931 932<A NAME="getSearchKeyRange(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> 933getSearchKeyRange</H3> 934<PRE> 935public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getSearchKeyRange</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 936 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 937 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 938 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 939 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 940<DL> 941<DD>Move the cursor to the closest matching key of the database, and return 942the data item associated with the matching key. If the matching key has 943duplicate values, the first data item in the set of duplicates is returned. 944<p> 945The returned key/data pair is for the smallest key greater than or equal 946to the specified key (as determined by the key comparison function), 947permitting partial key matches and range searches. 948<p> 949If this method fails for any reason, the position of the cursor will be 950unchanged. 951<P> 952<DD><DL> 953<DT><B>Parameters:</B><DD><CODE>key</CODE> - the secondary key 954used as input and returned as output. It must be initialized with a non-null 955byte array by the caller.<DD><CODE>pKey</CODE> - the primary key 956returned as output. Its byte array does not need to be initialized by the 957caller.<DD><CODE>data</CODE> - the primary data 958returned as output. Multiple results can be retrieved by passing an object 959that is a subclass of <A HREF="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db"><CODE>MultipleEntry</CODE></A>, otherwise its byte array does not 960need to be initialized by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. 961<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is 962found; <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <A HREF="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. 963<DT><B>Throws:</B> 964<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or 965does not contain a required non-null byte array. 966<p> 967<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 968deadlock. 969<p> 970<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 971<p> 972<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 973<p></DL> 974</DD> 975</DL> 976<HR> 977 978<A NAME="getSearchBoth(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> 979getSearchBoth</H3> 980<PRE> 981public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getSearchBoth</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 982 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 983 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 984 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 985 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 986<DL> 987<DD>Move the cursor to the specified secondary and primary key, where both 988the primary and secondary key items must match. 989<p> 990If this method fails for any reason, the position of the cursor will be 991unchanged. 992<P> 993<DD><DL> 994<DT><B>Parameters:</B><DD><CODE>key</CODE> - the secondary key 995used as input. It must be initialized with a non-null byte array by the 996caller.<DD><CODE>pKey</CODE> - the primary key 997used as input. It must be initialized with a non-null byte array by the 998caller.<DD><CODE>data</CODE> - the primary data 999returned as output. Its byte array does not need to be initialized by the 1000caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. 1001<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is 1002found; <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <A HREF="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. 1003<DT><B>Throws:</B> 1004<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or 1005does not contain a required non-null byte array. 1006<p> 1007<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 1008deadlock. 1009<p> 1010<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 1011<p> 1012<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 1013<p></DL> 1014</DD> 1015</DL> 1016<HR> 1017 1018<A NAME="getSearchBothRange(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> 1019getSearchBothRange</H3> 1020<PRE> 1021public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getSearchBothRange</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, 1022 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 1023 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 1024 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 1025 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1026<DL> 1027<DD>Move the cursor to the specified secondary key and closest matching primary 1028key of the database. 1029<p> 1030In the case of any database supporting sorted duplicate sets, the returned 1031key/data pair is for the smallest primary key greater than or equal to the 1032specified primary key (as determined by the key comparison function), 1033permitting partial matches and range searches in duplicate data sets. 1034<p> 1035If this method fails for any reason, the position of the cursor will be 1036unchanged. 1037<P> 1038<DD><DL> 1039<DT><B>Parameters:</B><DD><CODE>key</CODE> - the secondary key 1040used as input and returned as output. It must be initialized with a non-null 1041byte array by the caller.<DD><CODE>pKey</CODE> - the primary key 1042used as input and returned as output. It must be initialized with a non-null 1043byte array by the caller.<DD><CODE>data</CODE> - the primary data 1044returned as output. Its byte array does not need to be initialized by the 1045caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. 1046<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is 1047found; <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <A HREF="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. 1048<DT><B>Throws:</B> 1049<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or 1050does not contain a required non-null byte array. 1051<p> 1052<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 1053deadlock. 1054<p> 1055<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 1056<p> 1057<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 1058<p></DL> 1059</DD> 1060</DL> 1061<HR> 1062 1063<A NAME="getSearchRecordNumber(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> 1064getSearchRecordNumber</H3> 1065<PRE> 1066public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getSearchRecordNumber</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> secondaryRecno, 1067 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, 1068 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 1069 <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 1070 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1071<DL> 1072<DD>Move the cursor to the specific numbered record of the database, and 1073return the associated key/data pair. 1074<p> 1075The data field of the specified key must be a byte array containing a 1076record number, as described in <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A>. This determines 1077the record to be retrieved. 1078<p> 1079For this method to be called, the underlying database must be of type 1080Btree, and it must have been configured to support record numbers. 1081<p> 1082If this method fails for any reason, the position of the cursor will be 1083unchanged. 1084<P> 1085<DD><DL> 1086<DT><B>Parameters:</B><DD><CODE>secondaryRecno</CODE> - the secondary record number 1087used as input. It must be initialized with a non-null byte array by the 1088caller.<DD><CODE>data</CODE> - the primary data 1089returned as output. Multiple results can be retrieved by passing an object 1090that is a subclass of <A HREF="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db"><CODE>MultipleEntry</CODE></A>, otherwise its byte array does not 1091need to be initialized by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. 1092<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is 1093found; <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <A HREF="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. 1094<DT><B>Throws:</B> 1095<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or 1096does not contain a required non-null byte array. 1097<p> 1098<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 1099deadlock. 1100<p> 1101<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 1102<p> 1103<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 1104<p></DL> 1105</DD> 1106</DL> 1107<!-- ========= END OF CLASS DATA ========= --> 1108<HR> 1109 1110 1111<!-- ======= START OF BOTTOM NAVBAR ====== --> 1112<A NAME="navbar_bottom"><!-- --></A> 1113<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 1114<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 1115<TR> 1116<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 1117<A NAME="navbar_bottom_firstrow"><!-- --></A> 1118<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 1119 <TR ALIGN="center" VALIGN="top"> 1120 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 1121 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 1122 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 1123 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SecondaryCursor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 1124 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 1125 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 1126 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 1127 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 1128 </TR> 1129</TABLE> 1130</TD> 1131<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 1132<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 1133</TD> 1134</TR> 1135 1136<TR> 1137<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 1138 <A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> 1139 <A HREF="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 1140<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 1141 <A HREF="../../../index.html?com/sleepycat/db/SecondaryCursor.html" target="_top"><B>FRAMES</B></A> 1142 <A HREF="SecondaryCursor.html" target="_top"><B>NO FRAMES</B></A> 1143 <SCRIPT type="text/javascript"> 1144 <!-- 1145 if(window==top) { 1146 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 1147 } 1148 //--> 1149</SCRIPT> 1150<NOSCRIPT> 1151 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 1152</NOSCRIPT> 1153 1154 1155</FONT></TD> 1156</TR> 1157<TR> 1158<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 1159 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 1160<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 1161DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 1162</TR> 1163</TABLE> 1164<A NAME="skip-navbar_bottom"></A> 1165<!-- ======== END OF BOTTOM NAVBAR ======= --> 1166 1167<HR> 1168<font size=1>Copyright (c) 1996-2009 Oracle. All rights reserved.</font> 1169</BODY> 1170</HTML> 1171
