<html> <head> <title>Interface XConnectionTools</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="XConnectionTools-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">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></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">sdb</a> :: <a href="module-ix.html" class="namechain">tools</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XConnectionTools</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>encapsulates various useful functionality around a ::com::sun::star::<a href="../module-ix.html">sdb</a>::<a href="../Connection.html">Connection</a> </dd> <dd><p>Most of the functionality provided here is meaningful only relative to a given database connection. For instance, for quoting table names, you need the meta data instance of the connection. Thus, the entry point for obtaining a <a href="XConnectionTools.html">XConnectionTools</a> instance is the ::com::sun::star::<a href="../module-ix.html">sdb</a>::<a href="../Connection.html">Connection</a> service.</p> <p>Note that nearly all functionality provided by this interface is also available by other means, it's only provided here for convenience purposes.</p> </dd> <dt><b>Since </b></dt> <dd>OOo 2.0.4</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="#createTableName">createTableName</a></td> <td class="imsum_right">creates an instance supporting the <a href="XTableName.html">XTableName</a> interface, which can be used to manipulate table names for various purposes. </td> </tr> <tr> <td class="imsum_left"><a href="#getObjectNames">getObjectNames</a></td> <td class="imsum_right">returns an instance supporting the <a href="XObjectNames.html">XObjectNames</a> interface, which provides access to functionality around table and query names. </td> </tr> <tr> <td class="imsum_left"><a href="#getDataSourceMetaData">getDataSourceMetaData</a></td> <td class="imsum_right">provides access to the application-level data source meta data </td> </tr> <tr> <td class="imsum_left"><a href="#getFieldsByCommandDescriptor">getFieldsByCommandDescriptor</a></td> <td class="imsum_right">get fields for a result set given by a "command descriptor" </td> </tr> <tr> <td class="imsum_left"><a href="#getComposer">getComposer</a></td> <td class="imsum_right">get the composer initialized with a command and command type. </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="createTableName" class="membertitle">createTableName</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="XTableName.html">XTableName</a></td> </tr> <tr> <td valign="top"><b>createTableName</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates an instance supporting the <a href="XTableName.html">XTableName</a> interface, which can be used to manipulate table names for various purposes. </dd> <dd><p>The returned object is guaranteed to not be <b>NULL</b>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getObjectNames" class="membertitle">getObjectNames</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="XObjectNames.html">XObjectNames</a></td> </tr> <tr> <td valign="top"><b>getObjectNames</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns an instance supporting the <a href="XObjectNames.html">XObjectNames</a> interface, which provides access to functionality around table and query names. </dd> <dd><p>The returned object is guaranteed to not be <b>NULL</b>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDataSourceMetaData" class="membertitle">getDataSourceMetaData</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="XDataSourceMetaData.html">XDataSourceMetaData</a></td> </tr> <tr> <td valign="top"><b>getDataSourceMetaData</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides access to the application-level data source meta data </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getFieldsByCommandDescriptor" class="membertitle">getFieldsByCommandDescriptor</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="../../container/module-ix.html">container</a>::<a href="../../container/XNameAccess.html">XNameAccess</a></td> </tr> <tr> <td valign="top"><b>getFieldsByCommandDescriptor</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> commandType,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> command,</td> </tr> <tr> <td/><td valign="top">[out] ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/XComponent.html">XComponent</a></td> <td valign="bottom"> keepFieldsAlive )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../sdbc/module-ix.html">sdbc</a>::<a href="../../sdbc/SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>get fields for a result set given by a "command descriptor" </dd> <dd><p>A command descriptor here means: <ul><li>a SDB-level connection (com.sun.star.sdb::Connection</li> <li>a string specifying the name of an object relative to the connection</li> <li>a com.sun.star.sdb::CommandType value specifying the type of the object</li> </ul> </p> </dd> <dt><b>Parameter commandType</b></dt> <dd>the type of the object </dd> <dt><b>Parameter command</b></dt> <dd>the object. This may be a table name, a query name, or an SQL statement, depending on the value of <arg>_nCommandType</arg> </dd> <dt><b>Parameter _rxCollectionOner</b></dt> <dd>If (and only if) <arg>CommandType</arg> is CommandType.COMMAND, the fields collection which is returned by this function here is a temporary object. It is kept alive by another object, which is to be created temporarily, too. To ensure that the fields you get are valid as long as you need them, the owner which controls their life time is transfered to this parameter upon return.<br/> Your fields live as long as this component lives.<br/> Additionally, you are encouraged to dispose this component as soon as you don't need the fields anymore. It depends on the connection's implementation if this is necessary, but the is no guarantee, so to be on the safe side with respect to resource leaks, you should dispose the component. </dd> <dt><b>Returns</b></dt> <dd>the container of the columns (aka fields) of the object </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getComposer" class="membertitle">getComposer</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="../module-ix.html">sdb</a>::<a href="../XSingleSelectQueryComposer.html">XSingleSelectQueryComposer</a></td> </tr> <tr> <td valign="top"><b>getComposer</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> commandType,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> command );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>get the composer initialized with a command and command type. </dd> <dt><b>Parameter commandType</b></dt> <dd>the type of the object </dd> <dt><b>Parameter command</b></dt> <dd>the object. This may be a table name, a query name, or an SQL statement, depending on the value of <arg>_nCommandType</arg> </dd> <dt><b>Returns</b></dt> <dd>the composer filled with command and command type. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
