<html> <head> <title>Interface XRowLocate</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XRowLocate-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">sdbcx</a> :: </p> </td> </tr> <tr> <td class="title">interface XRowLocate</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>is used to identify rows within a result set and to find rows by a bookmark. </dd> <dd><p> Bookmarks are only valid in the scope of the current result set and are not interchangeable between result sets. A bookmark could be a complex data structure, so it could not be compared in a safe way. Because of that, a provider has to implement the compare method for bookmarks. </p> </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getBookmark">getBookmark</a></td> <td class="imsum_right">returns the bookmark of the current row of a result set. </td> </tr> <tr> <td class="imsum_left"><a href="#moveToBookmark">moveToBookmark</a></td> <td class="imsum_right">moves the cursor to the row identified by an valid bookmark. </td> </tr> <tr> <td class="imsum_left"><a href="#moveRelativeToBookmark">moveRelativeToBookmark</a></td> <td class="imsum_right">moves the cursor a relative number of rows, either positive or negative starting at a given bookmark position. </td> </tr> <tr> <td class="imsum_left"><a href="#compareBookmarks">compareBookmarks</a></td> <td class="imsum_right">compares two bookmarks and returns an indication of their relative values. </td> </tr> <tr> <td class="imsum_left"><a href="#hasOrderedBookmarks">hasOrderedBookmarks</a></td> <td class="imsum_right">determines whether the bookmarks of a result set are ordered or not. </td> </tr> <tr> <td class="imsum_left"><a href="#hashBookmark">hashBookmark</a></td> <td class="imsum_right">returns the hash value for a specified bookmark. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getBookmark" class="membertitle">getBookmark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">any</td> </tr> <tr> <td valign="top"><b>getBookmark</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the bookmark of the current row of a result set. </dd> <dt><b>Returns</b></dt> <dd>the current bookmark </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::sdbc::SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="moveToBookmark" class="membertitle">moveToBookmark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>moveToBookmark</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> bookmark )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>moves the cursor to the row identified by an valid bookmark. </dd> <dd><p> If the bookmark could not be located, a result set will be positioned after the last record. <br/> If the bookmark is invalid, or not generated by the current result set, then the behaviour is not defined, even an abnormal termination is possible. </p> </dd> <dt><b>Parameter bookmark</b></dt> <dd>the bookmark where to move </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if successful </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::sdbc::SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="moveRelativeToBookmark" class="membertitle">moveRelativeToBookmark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>moveRelativeToBookmark</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> bookmark,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> rows )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>moves the cursor a relative number of rows, either positive or negative starting at a given bookmark position. </dd> <dd><p> If the bookmark could not be located, a result set will be positioned after the last record. <br/> If the bookmark is invalid, or not generated by the current result set, then the behaviour is not defined, even an abnormal termination is possible. </p> </dd> <dt><b>Parameter bookmark</b></dt> <dd>the bookmark where to move </dd> <dt><b>Parameter rows</b></dt> <dd>count of rows move relative to the bookmark </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if successful </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::sdbc::SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="compareBookmarks" class="membertitle">compareBookmarks</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>compareBookmarks</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> first,</td> </tr> <tr> <td/><td valign="top">[in] any</td> <td valign="bottom"> second )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>compares two bookmarks and returns an indication of their relative values. </dd> <dd><p> The bookmarks must apply to the same ResultSet. You cannot reliably compare bookmarks from different ResultSets, even if they were created from the same source or statement. <br/> A bookmark that is not valid, or incorrectly formed, will cause an exception. </p> </dd> <dt><b>Parameter first</b></dt> <dd>the first bookmark </dd> <dt><b>Parameter second</b></dt> <dd>the second bookmark </dd> <dt><b>Returns</b></dt> <dd>a value of <a href="CompareBookmark.html">CompareBookmark</a> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::sdbc::SQLException if a database access error occurs. </dd> <dt><b>See also</b></dt> <dd><a href="CompareBookmark.html">CompareBookmark</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasOrderedBookmarks" class="membertitle">hasOrderedBookmarks</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>hasOrderedBookmarks</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines whether the bookmarks of a result set are ordered or not. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if so </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::sdbc::SQLException if a database access error occurs. </dd> <dt><b>See also</b></dt> <dd><a href="CompareBookmark.html">CompareBookmark</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hashBookmark" class="membertitle">hashBookmark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>hashBookmark</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> bookmark )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the hash value for a specified bookmark. </dd> <dt><b>Parameter bookmark</b></dt> <dd>the bookmark to hash </dd> <dt><b>Returns</b></dt> <dd>the hashed value </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::sdbc::SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
5352
