Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 5404

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Service ResultSet</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="ResultSet-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Database/Result_Sets" class="navimain">Devguide</a></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">Services' Summary</td>
<td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td>
<td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td>
<td class="navisub">Services' Details</td>
<td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td>
<td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></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">sdbc</a> :: </p>
</td>
</tr>
<tr>
<td class="title">service ResultSet</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to a table of data. A ResultSet
 object is usually generated by executing a Statement.
 
 
 
 </dd>
<dd><p>
 A ResultSet maintains a cursor pointing to its current row of
 data. Initially the cursor is positioned before the first row.
 The 'next' method moves the cursor to the next row.
 </p>
 <p>
 The getXXX methods retrieve column values for the current
 row. You can retrieve values using either the index number of the
 column. Columns are numbered from 1.
 </p>
 <p>
 For maximum portability, ResultSet columns within each row should be
 read in left-to-right order and each column should be read only once.
 </p>
 <p>
 For the getXXX methods, the SDBC driver attempts to convert the
 underlying data to the specified type and returns a suitable
 value.
 </p>
 <p>
 Column names used as input to the findColumn method are case
 insensitive. When several columns have the same name, then the value
 of the first matching column will be returned. The column name option is
 designed to be used when column names are used in the SQL
 query. For columns that are NOT explicitly named in the query, it
 is best to use column numbers. If column names are used, there is
 no way for the programmer to guarantee that they actually refer to
 the intended columns.
 </p>
 <p>
 A ResultSet is automatically closed (disposed) by the Statement that
 generated it when that Statement is closed, re-executed, or used
 to retrieve the next result from a sequence of multiple results.
 </p>
 <p>
 The number, types, and properties of a ResultSet's columns are
 provided by the ResultSetMetaData object returned by the getMetaData
 method.
 </p>
 </dd>
</dl>
<a name="devmanual"> </a><dl>
<dt><b>Developers Guide</b></dt>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Database/Result_Sets">Database - Result Sets</a></dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces - Summary</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></td>
<td class="imsum_right"><p>optional for implementation; controls the releasing of resources 
 and the notification of registered listeners.
 (<a href="#XComponent">details</a>)</p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XCloseable.html">XCloseable</a></td>
<td class="imsum_right"><p>freeing all resources of a result set. 
 
 (<a href="#XCloseable">details</a>)</p>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td>
<td class="imsum_right"><dl>
<dt>(referenced entity's summary:)</dt>
<dd>provides information about and access to the 
 properties from an implementation. 
 
 </dd>
</dl>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XWarningsSupplier.html">XWarningsSupplier</a></td>
<td class="imsum_right"><p>controls the chaining of warnings, which may occur on every call 
 to the connected database. 
 
 (<a href="#XWarningsSupplier">details</a>)</p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XResultSetMetaDataSupplier.html">XResultSetMetaDataSupplier</a></td>
<td class="imsum_right"><p>provides the access to the result set description.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XResultSet.html">XResultSet</a></td>
<td class="imsum_right"><p>is the interface for navigating on the rows on a result set.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XResultSetUpdate.html">XResultSetUpdate</a></td>
<td class="imsum_right"><p>is the interface for updating row data to the database. 
 
 (<a href="#XResultSetUpdate">details</a>)</p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XRow.html">XRow</a></td>
<td class="imsum_right"><p>is the interface for accessing the data of the current row.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XColumnLocate.html">XColumnLocate</a></td>
<td class="imsum_right"><p>is used for locating a column by it's name.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XRowUpdate.html">XRowUpdate</a></td>
<td class="imsum_right"><p>is the interface for updating the data of the current row. 
 
 (<a href="#XRowUpdate">details</a>)</p>
</td>
</tr>
</table>
<a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Properties' Summary</td>
</tr>
<tr>
<td class="imsum_left">[ readonly ] string<br>
<a href="#CursorName">CursorName</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>defines the SQL cursor name that will be used by subsequent Statement
 <code>execute</code>
 methods.
 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">[ readonly ] long<br>
<a href="#ResultSetConcurrency">ResultSetConcurrency</a></td>
<td class="imsum_right">retrieves the result set concurrency.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">[ readonly ] long<br>
<a href="#ResultSetType">ResultSetType</a></td>
<td class="imsum_right">determines the result set type.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">long<br>
<a href="#FetchDirection">FetchDirection</a></td>
<td class="imsum_right">retrieves the direction for fetching rows from database tables
 that is the default for result sets generated from this
 ::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/Statement.html">Statement</a>
 object.
 <br/>
 If this <code>Statement</code> object has not set a fetch direction,
 the return value is implementation-specific.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">long<br>
<a href="#FetchSize">FetchSize</a></td>
<td class="imsum_right">retrieves the number of result set rows that is the default fetch size
 for result sets generated from this 
 ::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/Statement.html">Statement</a>
 object.
 <br/>
 If this
 ::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/Statement.html">Statement</a>
 object has not set a fetch size,
 the return value is implementation-specific.
 &nbsp;</td>
</tr>
</table>
<a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces - Details</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XComponent" class="membertitle">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>optional for implementation; controls the releasing of resources 
 and the notification of registered listeners.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XCloseable" class="membertitle"><a href="XCloseable.html">XCloseable</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>freeing all resources of a result set. 
 
 </dd>
<dd><p>
 The creating statement will still be open after disposing. 
 </p>
 
 <p>
 This interface is mandatory only for JDBC conformance, 
 otherwise it is optional.
 </p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XPropertySet" class="membertitle">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt>(referenced entity's summary:)</dt>
<dd>provides information about and access to the 
 properties from an implementation. 
 
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XWarningsSupplier" class="membertitle"><a href="XWarningsSupplier.html">XWarningsSupplier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>controls the chaining of warnings, which may occur on every call 
 to the connected database. 
 
 </dd>
<dd><p>
 Chained warnings from previous calls will be cleared before processing a new call. 
 </p>
 
 <p>
 This interface is mandatory only for JDBC conformance, otherwise it is optional.
 </p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XResultSetMetaDataSupplier" class="membertitle"><a href="XResultSetMetaDataSupplier.html">XResultSetMetaDataSupplier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides the access to the result set description.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XResultSet" class="membertitle"><a href="XResultSet.html">XResultSet</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>is the interface for navigating on the rows on a result set.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XResultSetUpdate" class="membertitle"><a href="XResultSetUpdate.html">XResultSetUpdate</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>is the interface for updating row data to the database. 
 
 </dd>
<dd><p>
 The implementation is optional.
 </p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XRow" class="membertitle"><a href="XRow.html">XRow</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>is the interface for accessing the data of the current row.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XColumnLocate" class="membertitle"><a href="XColumnLocate.html">XColumnLocate</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>is used for locating a column by it's name.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XRowUpdate" class="membertitle"><a href="XRowUpdate.html">XRowUpdate</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>is the interface for updating the data of the current row. 
 
 </dd>
<dd><p>
 The implementation is optional.
 </p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Properties' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="CursorName" class="membertitle">CursorName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>[ readonly ] string <b>CursorName</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>defines the SQL cursor name that will be used by subsequent Statement
 <code>execute</code>
 methods.
 
 
 </dd>
<dd><p>
 This name can then be used in SQL positioned update/delete statements to
 identify the current row in the ResultSet generated by this statement. If
 the database doesn't support positioned update/delete, this property is
 a noop. To insure that a cursor has the proper isolation level to support
 updates, the cursor's SELECT statement should be of the form
 'select for update ...'. If the 'for update' phrase is omitted,
 positioned updates may fail.
 </p>
 <p>
 <b>
 Note:
 </b>
 By definition, positioned update/delete
 execution must be done by a different Statement than the one
 which generated the ResultSet being used for positioning. Also,
 cursor names must be unique within a connection.
 </p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="ResultSetConcurrency" class="membertitle">ResultSetConcurrency</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>[ readonly ] long <b>ResultSetConcurrency</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>retrieves the result set concurrency.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="ResultSetConcurrency.html">ResultSetConcurrency</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="ResultSetType" class="membertitle">ResultSetType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>[ readonly ] long <b>ResultSetType</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>determines the result set type.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="ResultSetType.html">ResultSetType</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FetchDirection" class="membertitle">FetchDirection</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>FetchDirection</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>retrieves the direction for fetching rows from database tables
 that is the default for result sets generated from this
 ::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/Statement.html">Statement</a>
 object.
 <br/>
 If this <code>Statement</code> object has not set a fetch direction,
 the return value is implementation-specific.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FetchSize" class="membertitle">FetchSize</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>FetchSize</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>retrieves the number of result set rows that is the default fetch size
 for result sets generated from this 
 ::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/Statement.html">Statement</a>
 object.
 <br/>
 If this
 ::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/Statement.html">Statement</a>
 object has not set a fetch size,
 the return value is implementation-specific.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<br>&nbsp;<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>