<html>
<head>
<title>Interface XParameters</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="XParameters-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">sdbc</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XParameters</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>is used for parameter setting, commonly implemented in conjunction with
PreparedStatements.
</dd>
<dd><p>
<b>Note:</b> The setXXX methods for setting IN parameter values
must specify types that are compatible with the defined SQL type of
the input parameter. For instance, if the IN parameter has SQL type
Integer, then the method
<a href="XParameters.html">XParameters</a>::<a href="XParameters.html#setInt">setInt()</a>
should be used.
</p>
<p>
If arbitrary parameter type conversions are required, the method
<a href="XParameters.html">XParameters</a>::<a href="XParameters.html#setObject">setObject()</a>
should be used with a target SQL type.
<br/>
<br/>
Example of setting a parameter;
<code>con</code>
is an active connection.
</p>
</dd>
<dt><b>Example</b></dt>
<dd><pre>pstmt = con.prepareStatement("UPDATE EMPLOYEES SET SALARY = ? WHERE ID = ?")
pstmt.setDouble(1, 153833.00)
pstmt.setLong(2, 110592)
</pre></dd>
<dt><b>See also</b></dt>
<dd><a href="XPreparedStatement.html">XPreparedStatement</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="#setNull">setNull</a></td>
<td class="imsum_right">sets the designated parameter to SQL NULL.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setObjectNull">setObjectNull</a></td>
<td class="imsum_right">sets the designated parameter to SQL NULL. This version of setNull should
be used for user-named types and REF type parameters. Examples
of user-named types include: STRUCT, DISTINCT, OBJECT, and
named array types.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setBoolean">setBoolean</a></td>
<td class="imsum_right">sets the designated parameter to a boolean value. The driver converts this
to a SQL BIT value when it sends it to the database.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setByte">setByte</a></td>
<td class="imsum_right">sets the designated parameter to a byte value. The driver converts this
to a SQL TINYINT value when it sends it to the database.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setShort">setShort</a></td>
<td class="imsum_right">sets the designated parameter to a short value. The driver converts this
to a SQL SMALLINT value when it sends it to the database.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setInt">setInt</a></td>
<td class="imsum_right">sets the designated parameter to a long value. The driver converts this
to a SQL INTEGER value when it sends it to the database.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setLong">setLong</a></td>
<td class="imsum_right">sets the designated parameter to a hyper value. The driver converts this
to a SQL BIGINT value when it sends it to the database.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setFloat">setFloat</a></td>
<td class="imsum_right">sets the designated parameter to a float value. The driver converts this
to a SQL FLOAT value when it sends it to the database.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setDouble">setDouble</a></td>
<td class="imsum_right">sets the designated parameter to a double value. The driver converts this
to a SQL DOUBLE value when it sends it to the database.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setString">setString</a></td>
<td class="imsum_right">sets the designated parameter to a string value. The driver converts this
to a SQL VARCHAR or LONGVARCHAR value (depending on the argument's
size relative to the driver's limits on VARCHARs) when it sends
it to the database.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setBytes">setBytes</a></td>
<td class="imsum_right">sets the designated parameter to a sequence of bytes. The driver converts
this to a SQL VARBINARY or LONGVARBINARY (depending on the
argument's size relative to the driver's limits on VARBINARYs)
when it sends it to the database.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setDate">setDate</a></td>
<td class="imsum_right">sets the designated parameter to a date value. The driver converts this
to a SQL DATE value when it sends it to the database.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setTime">setTime</a></td>
<td class="imsum_right">sets the designated parameter to a time value. The driver converts this
to a SQL TIME value when it sends it to the database.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setTimestamp">setTimestamp</a></td>
<td class="imsum_right">sets the designated parameter to a datetime value. The driver
converts this to a SQL TIMESTAMP value when it sends it to the
database.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setBinaryStream">setBinaryStream</a></td>
<td class="imsum_right">sets the designated parameter to the given input stream, which will have
the specified number of bytes.
When a very large binary value is input to a LONGVARBINARY or LONGVARCHAR
parameter, it may be more practical to send it via an
::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a>
. SDBC will read the data from the stream as needed, until it reaches end-of-file.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setCharacterStream">setCharacterStream</a></td>
<td class="imsum_right">sets the designated parameter to the given input stream, which will have
the specified number of bytes.
When a very large binary value is input to a LONGVARCHAR
parameter, it may be more practical to send it via a
::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a>
. SDBC will read the data from the stream as needed, until it reaches end-of-file.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setObject">setObject</a></td>
<td class="imsum_right">sets the value of a parameter using an any.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setObjectWithInfo">setObjectWithInfo</a></td>
<td class="imsum_right">set a value from the Datatype ANY for a parameter.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setRef">setRef</a></td>
<td class="imsum_right">sets a REF(&lt;structured-type&gt;) parameter.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setBlob">setBlob</a></td>
<td class="imsum_right">sets a BLOB parameter.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setClob">setClob</a></td>
<td class="imsum_right">sets a CLOB parameter.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setArray">setArray</a></td>
<td class="imsum_right">sets an Array parameter.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#clearParameters">clearParameters</a></td>
<td class="imsum_right">clears the current parameter values immediately.
</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="setNull" class="membertitle">setNull</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">void</td>
</tr>
<tr>
<td valign="top"><b>setNull</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom"> sqlType )</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>sets the designated parameter to SQL NULL.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setObjectNull" class="membertitle">setObjectNull</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">void</td>
</tr>
<tr>
<td valign="top"><b>setObjectNull</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom"> sqlType,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom"> typeName )</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>sets the designated parameter to SQL NULL. This version of setNull should
be used for user-named types and REF type parameters. Examples
of user-named types include: STRUCT, DISTINCT, OBJECT, and
named array types.
</dd>
<dd><p>
<b>Note:</b> To be portable, applications must give the
SQL type code and the fully-qualified SQL type name when specifying
a NULL user-defined or REF parameter. In the case of a user-named type
the name is the type name of the parameter itself. For a REF
parameter the name is the type name of the referenced type. If
a SDBC driver does not need the type code or type name information,
it may ignore it.
<br/>
Although it is intended for user-named and Ref parameters,
this method may be used to set a null parameter of any JDBC type.
If the parameter does not have a user-named or REF type, the given
typeName is ignored.
</p>
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter sqlType</b></dt>
<dd>the type of the column to set to <b>NULL</b>
</dd>
<dt><b>Parameter typeName</b></dt>
<dd>the name of the type
</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="setBoolean" class="membertitle">setBoolean</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">void</td>
</tr>
<tr>
<td valign="top"><b>setBoolean</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom"> x )</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>sets the designated parameter to a boolean value. The driver converts this
to a SQL BIT value when it sends it to the database.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="setByte" class="membertitle">setByte</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">void</td>
</tr>
<tr>
<td valign="top"><b>setByte</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] byte</td>
<td valign="bottom"> x )</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>sets the designated parameter to a byte value. The driver converts this
to a SQL TINYINT value when it sends it to the database.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="setShort" class="membertitle">setShort</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">void</td>
</tr>
<tr>
<td valign="top"><b>setShort</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] short</td>
<td valign="bottom"> x )</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>sets the designated parameter to a short value. The driver converts this
to a SQL SMALLINT value when it sends it to the database.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="setInt" class="membertitle">setInt</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">void</td>
</tr>
<tr>
<td valign="top"><b>setInt</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom"> x )</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>sets the designated parameter to a long value. The driver converts this
to a SQL INTEGER value when it sends it to the database.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="setLong" class="membertitle">setLong</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">void</td>
</tr>
<tr>
<td valign="top"><b>setLong</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] hyper</td>
<td valign="bottom"> x )</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>sets the designated parameter to a hyper value. The driver converts this
to a SQL BIGINT value when it sends it to the database.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="setFloat" class="membertitle">setFloat</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">void</td>
</tr>
<tr>
<td valign="top"><b>setFloat</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] float</td>
<td valign="bottom"> x )</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>sets the designated parameter to a float value. The driver converts this
to a SQL FLOAT value when it sends it to the database.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="setDouble" class="membertitle">setDouble</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">void</td>
</tr>
<tr>
<td valign="top"><b>setDouble</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] double</td>
<td valign="bottom"> x )</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>sets the designated parameter to a double value. The driver converts this
to a SQL DOUBLE value when it sends it to the database.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="setString" class="membertitle">setString</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">void</td>
</tr>
<tr>
<td valign="top"><b>setString</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom"> x )</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>sets the designated parameter to a string value. The driver converts this
to a SQL VARCHAR or LONGVARCHAR value (depending on the argument's
size relative to the driver's limits on VARCHARs) when it sends
it to the database.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="setBytes" class="membertitle">setBytes</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">void</td>
</tr>
<tr>
<td valign="top"><b>setBytes</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] sequence< byte ></td>
<td valign="bottom"> x )</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>sets the designated parameter to a sequence of bytes. The driver converts
this to a SQL VARBINARY or LONGVARBINARY (depending on the
argument's size relative to the driver's limits on VARBINARYs)
when it sends it to the database.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="setDate" class="membertitle">setDate</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">void</td>
</tr>
<tr>
<td valign="top"><b>setDate</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Date.html">Date</a></td>
<td valign="bottom"> x )</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>sets the designated parameter to a date value. The driver converts this
to a SQL DATE value when it sends it to the database.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="setTime" class="membertitle">setTime</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">void</td>
</tr>
<tr>
<td valign="top"><b>setTime</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Time.html">Time</a></td>
<td valign="bottom"> x )</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>sets the designated parameter to a time value. The driver converts this
to a SQL TIME value when it sends it to the database.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="setTimestamp" class="membertitle">setTimestamp</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">void</td>
</tr>
<tr>
<td valign="top"><b>setTimestamp</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/DateTime.html">DateTime</a></td>
<td valign="bottom"> x )</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>sets the designated parameter to a datetime value. The driver
converts this to a SQL TIMESTAMP value when it sends it to the
database.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="setBinaryStream" class="membertitle">setBinaryStream</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">void</td>
</tr>
<tr>
<td valign="top"><b>setBinaryStream</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a></td>
<td valign="bottom"> x,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom"> length )</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>sets the designated parameter to the given input stream, which will have
the specified number of bytes.
When a very large binary value is input to a LONGVARBINARY or LONGVARCHAR
parameter, it may be more practical to send it via an
::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a>
. SDBC will read the data from the stream as needed, until it reaches end-of-file.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</dd>
<dt><b>Parameter length</b></dt>
<dd>the number of bytes in the stream
</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="setCharacterStream" class="membertitle">setCharacterStream</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">void</td>
</tr>
<tr>
<td valign="top"><b>setCharacterStream</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a></td>
<td valign="bottom"> x,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom"> length )</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>sets the designated parameter to the given input stream, which will have
the specified number of bytes.
When a very large binary value is input to a LONGVARCHAR
parameter, it may be more practical to send it via a
::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a>
. SDBC will read the data from the stream as needed, until it reaches end-of-file.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</dd>
<dt><b>Parameter length</b></dt>
<dd>the number of characters in the stream
</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="setObject" class="membertitle">setObject</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">void</td>
</tr>
<tr>
<td valign="top"><b>setObject</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] any</td>
<td valign="bottom"> x )</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>sets the value of a parameter using an any.
</dd>
<dd><p>The given object will be converted to the targetSqlType
before being sent to the database.
If the object has a custom mapping (is of a class implementing SQLData),
the SDBC driver should call its method <code>writeSQL</code> to write it
to the SQL data stream.
If, on the other hand, the object is of a service implementing Ref, Blob,
Clob, Struct, or Array, the driver should pass it to the database as a
value of the corresponding SQL type.
</p>
<p>Note that this method may be used to pass database-specific
abstract data types.
</p>
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="setObjectWithInfo" class="membertitle">setObjectWithInfo</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">void</td>
</tr>
<tr>
<td valign="top"><b>setObjectWithInfo</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] any</td>
<td valign="bottom"> x,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom"> targetSqlType,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom"> scale )</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>set a value from the Datatype ANY for a parameter.
</dd>
<dd><p>The given object will be converted to the targetSqlType
before being sent to the database.
If the object has a custom mapping (is of a class implementing SQLData),
the SDBC driver should call its method <code>writeSQL</code> to write it
to the SQL data stream.
If, on the other hand, the object is of a service implementing Ref, Blob,
Clob, Struct, or Array, the driver should pass it to the database as a
value of the corresponding SQL type.
</p>
<p>Note that this method may be used to pass database-specific
abstract data types.
</p>
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</dd>
<dt><b>Parameter targetSqlType</b></dt>
<dd>the SQL type (as defined in
<a href="DataType.html">DataType</a>
) to be sent to the database. The scale argument may further qualify this type.
</dd>
<dt><b>Parameter scale</b></dt>
<dd>for
<a href="DataType.html">DataType</a>::<a href="DataType.html#DECIMAL">DECIMAL</a>
or
<a href="DataType.html">DataType</a>::<a href="DataType.html#NUMERIC">NUMERIC</a>
types, this is the number of digits after the decimal point. For all other types, this value will be ignored.
</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="setRef" class="membertitle">setRef</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">void</td>
</tr>
<tr>
<td valign="top"><b>setRef</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XRef.html">XRef</a></td>
<td valign="bottom"> x )</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>sets a REF(&lt;structured-type&gt;) parameter.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="setBlob" class="membertitle">setBlob</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">void</td>
</tr>
<tr>
<td valign="top"><b>setBlob</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XBlob.html">XBlob</a></td>
<td valign="bottom"> x )</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>sets a BLOB parameter.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="setClob" class="membertitle">setClob</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">void</td>
</tr>
<tr>
<td valign="top"><b>setClob</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XClob.html">XClob</a></td>
<td valign="bottom"> x )</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>sets a CLOB parameter.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="setArray" class="membertitle">setArray</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">void</td>
</tr>
<tr>
<td valign="top"><b>setArray</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> parameterIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XArray.html">XArray</a></td>
<td valign="bottom"> x )</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>sets an Array parameter.
</dd>
<dt><b>Parameter parameterIndex</b></dt>
<dd>the first parameter is 1, the second is 2, ...
</dd>
<dt><b>Parameter x</b></dt>
<dd>the parameter value
</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="clearParameters" class="membertitle">clearParameters</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">void</td>
</tr>
<tr>
<td valign="top"><b>clearParameters</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>clears the current parameter values immediately.
</dd>
<dd><p>In general, parameter values remain in force for repeated use of a
Statement. Setting a parameter value automatically clears its
previous value. However, in some cases it is useful to immediately
release the resources used by the current parameter values; this can
be done by calling clearParameters.
</p>
</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 © 2008 Sun Microsystems, Inc.</p>
</div> <!-- id="adc-idlref" -->
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
5225
