Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 5243

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XRow</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="XRow-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Database/Using_the_getXXX_Methods" 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"><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">sdbc</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XRow</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>is used to access data which is collected in a row.
 All methods raise a 
 <a href="SQLException.html">SQLException</a>
 if a database access error occurs.
 </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/Using_the_getXXX_Methods">Database - Using the getXXX Methods</a></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="#wasNull">wasNull</a></td>
<td class="imsum_right">reports whether the last column read had a value of SQL NULL.
 Note that you must first call getXXX on a column to try to read
 its value and then call wasNull() to see if the value read was
 SQL NULL.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getString">getString</a></td>
<td class="imsum_right">gets the value of a column in the current row as a string.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getBoolean">getBoolean</a></td>
<td class="imsum_right">gets the value of a column in the current row as boolean.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getByte">getByte</a></td>
<td class="imsum_right">get the value of a column in the current row as a byte.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getShort">getShort</a></td>
<td class="imsum_right">gets the value of a column in the current row as a short.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getInt">getInt</a></td>
<td class="imsum_right">get the value of a column in the current row as an integer.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getLong">getLong</a></td>
<td class="imsum_right">get the value of a column in the current row as a long.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getFloat">getFloat</a></td>
<td class="imsum_right">gets the value of a column in the current row as a float.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getDouble">getDouble</a></td>
<td class="imsum_right">gets the value of a column in the current row as a double.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getBytes">getBytes</a></td>
<td class="imsum_right">gets the value of a column in the current row as a byte array. 
 The bytes represent the raw values returned by the driver. 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getDate">getDate</a></td>
<td class="imsum_right">gets the value of a column in the current row as a date object.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getTime">getTime</a></td>
<td class="imsum_right">gets the value of a column in the current row as a time object.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getTimestamp">getTimestamp</a></td>
<td class="imsum_right">gets the value of a column in the current row as a datetime object.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getBinaryStream">getBinaryStream</a></td>
<td class="imsum_right">gets the value of a column in the current row as a stream of
 uninterpreted bytes. The value can then be read in chunks from the
 stream. This method is particularly suitable for retrieving large
 LONGVARBINARY values.
 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getCharacterStream">getCharacterStream</a></td>
<td class="imsum_right">gets the value of a column in the current row as a stream of
 uninterpreted bytes. The value can then be read in chunks from the
 stream. This method is particularly suitable for retrieving large
 LONGVARBINARY or LONGVARCHAR values.
 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getObject">getObject</a></td>
<td class="imsum_right">returns the value of a column in the current row as an object.
 This method uses the given 
 <code>Map</code>
 object for the custom mapping of the SQL structure or distinct type
 that is being retrieved.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getRef">getRef</a></td>
<td class="imsum_right">gets a REF(&amp;lt;structured-type&amp;gt;) column value from the current row.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getBlob">getBlob</a></td>
<td class="imsum_right">gets a BLOB value in the current row.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getClob">getClob</a></td>
<td class="imsum_right">gets a CLOB value in the current row of this 
 <code>ResultSet</code> 
 object.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getArray">getArray</a></td>
<td class="imsum_right">gets a SQL ARRAY value from the current row of this 
 <code>ResultSet</code> 
 object.
 &nbsp;</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="wasNull" class="membertitle">wasNull</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>wasNull</b>()</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>reports whether the last column read had a value of SQL NULL.
 Note that you must first call getXXX on a column to try to read
 its value and then call wasNull() to see if the value read was
 SQL NULL.

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b> if last column read was SQL NULL and <b>false</b> otherwise
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getString" class="membertitle">getString</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">string</td>
</tr>
<tr>
<td valign="top"><b>getString</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets the value of a column in the current row as a string.
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getBoolean" class="membertitle">getBoolean</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>getBoolean</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets the value of a column in the current row as boolean.
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getByte" class="membertitle">getByte</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">byte</td>
</tr>
<tr>
<td valign="top"><b>getByte</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>get the value of a column in the current row as a byte.
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getShort" class="membertitle">getShort</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">short</td>
</tr>
<tr>
<td valign="top"><b>getShort</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets the value of a column in the current row as a short.
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getInt" class="membertitle">getInt</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>getInt</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>get the value of a column in the current row as an integer.
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getLong" class="membertitle">getLong</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">hyper</td>
</tr>
<tr>
<td valign="top"><b>getLong</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>get the value of a column in the current row as a long.
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getFloat" class="membertitle">getFloat</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">float</td>
</tr>
<tr>
<td valign="top"><b>getFloat</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets the value of a column in the current row as a float.
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getDouble" class="membertitle">getDouble</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">double</td>
</tr>
<tr>
<td valign="top"><b>getDouble</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets the value of a column in the current row as a double.
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getBytes" class="membertitle">getBytes</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">sequence&lt; byte &gt;</td>
</tr>
<tr>
<td valign="top"><b>getBytes</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets the value of a column in the current row as a byte array. 
 The bytes represent the raw values returned by the driver. 
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2, ... 
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is empty. 
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getDate" class="membertitle">getDate</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">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Date.html">Date</a></td>
</tr>
<tr>
<td valign="top"><b>getDate</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets the value of a column in the current row as a date object.
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getTime" class="membertitle">getTime</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">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Time.html">Time</a></td>
</tr>
<tr>
<td valign="top"><b>getTime</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets the value of a column in the current row as a time object.
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getTimestamp" class="membertitle">getTimestamp</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">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/DateTime.html">DateTime</a></td>
</tr>
<tr>
<td valign="top"><b>getTimestamp</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets the value of a column in the current row as a datetime object.
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getBinaryStream" class="membertitle">getBinaryStream</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">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a></td>
</tr>
<tr>
<td valign="top"><b>getBinaryStream</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets the value of a column in the current row as a stream of
 uninterpreted bytes. The value can then be read in chunks from the
 stream. This method is particularly suitable for retrieving large
 LONGVARBINARY values.
 
 
 </dd>
<dd><p>
 <b>Note:</b> All the data in the returned stream must be
 read prior to getting the value of any other column. The next
 call to a get method implicitly closes the stream. Also, a
 stream may return 0 when the method 
 ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a>::<a href="../io/XInputStream.html#available">available()</a>
 is called whether there is data
 available or not.
 </p>
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getCharacterStream" class="membertitle">getCharacterStream</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">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a></td>
</tr>
<tr>
<td valign="top"><b>getCharacterStream</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets the value of a column in the current row as a stream of
 uninterpreted bytes. The value can then be read in chunks from the
 stream. This method is particularly suitable for retrieving large
 LONGVARBINARY or LONGVARCHAR values.
 
 
 </dd>
<dd><p>
 <b>Note:</b> All the data in the returned stream must be
 read prior to getting the value of any other column. The next
 call to a get method implicitly closes the stream. Also, a
 stream may return 0 when the method 
 ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a>::<a href="../io/XInputStream.html#available">available()</a>
 is called whether there is data
 available or not.
 </p>
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getObject" class="membertitle">getObject</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>getObject</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a></td>
<td valign="bottom">&nbsp;typeMap )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the value of a column in the current row as an object.
 This method uses the given 
 <code>Map</code>
 object for the custom mapping of the SQL structure or distinct type
 that is being retrieved.
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Parameter typeMap</b></dt>
<dd>the map of types which should be used to get the column value
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getRef" class="membertitle">getRef</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"><a href="XRef.html">XRef</a></td>
</tr>
<tr>
<td valign="top"><b>getRef</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets a REF(&amp;lt;structured-type&amp;gt;) column value from the current row.
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getBlob" class="membertitle">getBlob</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"><a href="XBlob.html">XBlob</a></td>
</tr>
<tr>
<td valign="top"><b>getBlob</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets a BLOB value in the current row.
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getClob" class="membertitle">getClob</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"><a href="XClob.html">XClob</a></td>
</tr>
<tr>
<td valign="top"><b>getClob</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets a CLOB value in the current row of this 
 <code>ResultSet</code> 
 object.
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>SQLException 
 if a database access error occurs.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getArray" class="membertitle">getArray</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"><a href="XArray.html">XArray</a></td>
</tr>
<tr>
<td valign="top"><b>getArray</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;columnIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets a SQL ARRAY value from the current row of this 
 <code>ResultSet</code> 
 object.
 </dd>
<dt><b>Parameter columnIndex</b></dt>
<dd>the first column is 1, the second is 2,
 </dd>
<dt><b>Returns</b></dt>
<dd>the column value; if the value is SQL NULL, the result is null
 </dd>
<dt><b>Throws</b></dt>
<dd>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 &copy; 2008 Sun Microsystems, Inc.</p>

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

</html>