Content for Apache OpenOffice version 3.4.
:: com :: sun :: star :: sdbcx ::
|
| interface XRowLocate |
|
- Description
- is used to identify rows within a result set and to find rows by a bookmark.
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.
|
| Methods' Summary |
| getBookmark |
returns the bookmark of the current row of a result set.
|
| moveToBookmark |
moves the cursor to the row identified by an valid bookmark.
|
| moveRelativeToBookmark |
moves the cursor a relative number of rows, either positive or negative
starting at a given bookmark position.
|
| compareBookmarks |
compares two bookmarks and returns an indication of their relative values.
|
| hasOrderedBookmarks |
determines whether the bookmarks of a result set are ordered or not.
|
| hashBookmark |
returns the hash value for a specified bookmark.
|
| Methods' Details |
getBookmark
- Description
- returns the bookmark of the current row of a result set.
- Returns
- the current bookmark
- Throws
- com::sun::star::sdbc::SQLException
if a database access error occurs.
|
|
moveToBookmark
| boolean |
| moveToBookmark( |
[in] any |
bookmark ) |
| raises( |
::com::sun::star::sdbc::SQLException ); |
- Description
- moves the cursor to the row identified by an valid bookmark.
If the bookmark could not be located, a result set will be positioned
after the last record.
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.
- Parameter bookmark
- the bookmark where to move
- Returns
- true if successful
- Throws
- com::sun::star::sdbc::SQLException
if a database access error occurs.
|
|
moveRelativeToBookmark
| boolean |
| moveRelativeToBookmark( |
[in] any |
bookmark, |
| [in] long |
rows ) |
| raises( |
::com::sun::star::sdbc::SQLException ); |
- Description
- moves the cursor a relative number of rows, either positive or negative
starting at a given bookmark position.
If the bookmark could not be located, a result set will be positioned
after the last record.
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.
- Parameter bookmark
- the bookmark where to move
- Parameter rows
- count of rows move relative to the bookmark
- Returns
- true if successful
- Throws
- com::sun::star::sdbc::SQLException
if a database access error occurs.
|
|
compareBookmarks
| long |
| compareBookmarks( |
[in] any |
first, |
| [in] any |
second ) |
| raises( |
::com::sun::star::sdbc::SQLException ); |
- Description
- compares two bookmarks and returns an indication of their relative values.
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.
A bookmark that is not valid, or incorrectly formed, will cause an exception.
- Parameter first
- the first bookmark
- Parameter second
- the second bookmark
- Returns
- a value of CompareBookmark
- Throws
- com::sun::star::sdbc::SQLException
if a database access error occurs.
- See also
- CompareBookmark
|
|
hasOrderedBookmarks
- Description
- determines whether the bookmarks of a result set are ordered or not.
- Returns
- true if so
- Throws
- com::sun::star::sdbc::SQLException
if a database access error occurs.
- See also
- CompareBookmark
|
|
hashBookmark
| long |
| hashBookmark( |
[in] any |
bookmark ) |
| raises( |
::com::sun::star::sdbc::SQLException ); |
- Description
- returns the hash value for a specified bookmark.
- Parameter bookmark
- the bookmark to hash
- Returns
- the hashed value
- Throws
- com::sun::star::sdbc::SQLException
if a database access error occurs.
|
|
Top of Page
Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.
