<html> <head> <title>Interface XOutParameters</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="XOutParameters-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Database/Stored_Procedures" 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 XOutParameters</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>is used to register Out-Parameters for stored procedures. </dd> <dd><p> SDBC provides a stored procedure SQL escape that allows stored procedures to be called in a standard way for all RDBMSs. This escape syntax has one form that includes a result parameter and one that does not. If used, the result parameter must be registered as an OUT parameter. The other parameters can be used for input, output, or both. Parameters are referred to sequentially, by number. The first parameter is 1. </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/Stored_Procedures">Database - Stored Procedures</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="#registerOutParameter">registerOutParameter</a></td> <td class="imsum_right">registers the designated output parameter. This version of the method <a href="XOutParameters.html">XOutParameters</a>::<a href="XOutParameters.html#registerOutParameter">registerOutParameter()</a> should be used for a user-named or REF output parameter. Examples of user-named types include: STRUCT, DISTINCT, OBJECT, and named array types. </td> </tr> <tr> <td class="imsum_left"><a href="#registerNumericOutParameter">registerNumericOutParameter</a></td> <td class="imsum_right">registers the OUT parameter in ordinal position <code>parameterIndex</code> to the SDBC type <code>sqlType</code> . All OUT parameters must be registered before a stored procedure is executed. </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="registerOutParameter" class="membertitle">registerOutParameter</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>registerOutParameter</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>registers the designated output parameter. This version of the method <a href="XOutParameters.html">XOutParameters</a>::<a href="XOutParameters.html#registerOutParameter">registerOutParameter()</a> should be used for a user-named or REF output parameter. Examples of user-named types include: STRUCT, DISTINCT, OBJECT, and named array types. </dd> <dd><p> Before executing a stored procedure call, you must explicitly call <a href="XOutParameters.html">XOutParameters</a>::<a href="XOutParameters.html#registerOutParameter">registerOutParameter()</a> to register the type from <a href="DataType.html">DataType</a> for each OUT parameter. <br/> For a user-named parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. An SDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-named and REF parameters. </p> <p>Although it is intended for user-named and REF parameters, this method may be used to register a parameter of any SDBC type. If the parameter does not have a user-named or REF type, the typeName parameter is ignored. </p> <p> <b>Note:</b> When reading the value of an out parameter, you must use the <code>getXXX</code> method whose type XXX corresponds to the parameter's registered SQL type. </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 register </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="registerNumericOutParameter" class="membertitle">registerNumericOutParameter</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>registerNumericOutParameter</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] 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>registers the OUT parameter in ordinal position <code>parameterIndex</code> to the SDBC type <code>sqlType</code> . All OUT parameters must be registered before a stored procedure is executed. </dd> <dd><p> The SDBC type specified by <code>sqlType</code> for an OUT parameter determines the type that must be used in the <code>get</code> method to read the value of that parameter. This version of <a href="XOutParameters.html">XOutParameters</a>::<a href="XOutParameters.html#registerOutParameter">registerOutParameter()</a> should be used when the parameter is of SDBC type <a href="DataType.html">DataType</a>::<a href="DataType.html#NUMERIC">NUMERIC</a> or <a href="DataType.html">DataType</a>::<a href="DataType.html#DECIMAL">DECIMAL</a> . </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 register </dd> <dt><b>Parameter scale</b></dt> <dd>the scale of the type </dd> <dt><b>Throws</b></dt> <dd>SQLException if a database access error occurs. </p> </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
>
5223
