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