Sophie

Sophie

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

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

<html>
<head>
<title>Interface XDataSource</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="XDataSource-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Database/Connecting_Through_a_DataSource" 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 XDataSource</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>is used for establishing connections via a factory which is identified
 by its name. A DataSource object is typically registered by a naming service
 provider.
 </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/Connecting_Through_a_DataSource">Database - Connecting Through a DataSource</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="#getConnection">getConnection</a></td>
<td class="imsum_right">attempts to establish a database connection.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setLoginTimeout">setLoginTimeout</a></td>
<td class="imsum_right">sets the maximum time in seconds that this data source will wait
 while attempting to connect to a database.
 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getLoginTimeout">getLoginTimeout</a></td>
<td class="imsum_right">gets the maximum time in seconds that this data source can wait
 while attempting to connect to a database.
 
 
 &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="getConnection" class="membertitle">getConnection</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="XConnection.html">XConnection</a></td>
</tr>
<tr>
<td valign="top"><b>getConnection</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;user,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;password )</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>attempts to establish a database connection.
 </dd>
<dt><b>Parameter user</b></dt>
<dd>the user name
 </dd>
<dt><b>Parameter password</b></dt>
<dd>the password
 </dd>
<dt><b>Returns</b></dt>
<dd>the connection object
 </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="setLoginTimeout" class="membertitle">setLoginTimeout</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>setLoginTimeout</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;seconds )</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 maximum time in seconds that this data source will wait
 while attempting to connect to a database.
 
 
 </dd>
<dd><p>
 A value of zero specifies that the timeout is the default system
 timeout if there is one; otherwise, it specifies that there is no timeout.
 When a DataSource object is created the login timeout is initially zero.
 </p>
 </dd>
<dt><b>Parameter seconds</b></dt>
<dd>the login time limit in seconds
 </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="getLoginTimeout" class="membertitle">getLoginTimeout</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>getLoginTimeout</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>gets the maximum time in seconds that this data source can wait
 while attempting to connect to a database.
 
 
 </dd>
<dd><p>
 A value of zero means that the timeout is the default system timeout
 if there is one; otherwise, it means that there is no timeout. When a
 DataSource object is created the login timeout is initially zero.
 </p>
 </dd>
<dt><b>Returns</b></dt>
<dd>the login time limit in seconds
 </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>