<html> <head> <title>Interface XSQLQueryComposer</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="XSQLQueryComposer-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">sdb</a> :: </p> </td> </tr> <tr> <td class="title">interface XSQLQueryComposer</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>should be provided by a tool which simplifies the handling with SQL select statements. </dd> <dd><p> The interface can be used for composing SELECT statements without knowing the structure of the used query. </p> </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="#getQuery">getQuery</a></td> <td class="imsum_right">returns the query used for composing. </td> </tr> <tr> <td class="imsum_left"><a href="#setQuery">setQuery</a></td> <td class="imsum_right">sets a new query for the composer, which may be expanded by filters and sort criteria. </td> </tr> <tr> <td class="imsum_left"><a href="#getComposedQuery">getComposedQuery</a></td> <td class="imsum_right">returns the query composed with filters and sort criterias. </td> </tr> <tr> <td class="imsum_left"><a href="#getFilter">getFilter</a></td> <td class="imsum_right">returns the currently used filter. </td> </tr> <tr> <td class="imsum_left"><a href="#getStructuredFilter">getStructuredFilter</a></td> <td class="imsum_right">returns the currently used filter. </td> </tr> <tr> <td class="imsum_left"><a href="#getOrder">getOrder</a></td> <td class="imsum_right">returns the currently used sort order. </td> </tr> <tr> <td class="imsum_left"><a href="#appendFilterByColumn">appendFilterByColumn</a></td> <td class="imsum_right">appends a new filter condition by a <a href="DataColumn.html">DataColumn</a> providing the name and the value for the filter. </td> </tr> <tr> <td class="imsum_left"><a href="#appendOrderByColumn">appendOrderByColumn</a></td> <td class="imsum_right">appends an additional part to the sort order criteria of the select statement. </td> </tr> <tr> <td class="imsum_left"><a href="#setFilter">setFilter</a></td> <td class="imsum_right">makes it possible to set a filter condition for the query. </td> </tr> <tr> <td class="imsum_left"><a href="#setOrder">setOrder</a></td> <td class="imsum_right">makes it possibile to set a sort condition for the query. </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="getQuery" class="membertitle">getQuery</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>getQuery</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the query used for composing. </dd> <dt><b>Returns</b></dt> <dd>the query </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setQuery" class="membertitle">setQuery</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>setQuery</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> command )</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>sets a new query for the composer, which may be expanded by filters and sort criteria. </dd> <dt><b>Parameter command</b></dt> <dd>the command to set </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::sdbc::SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getComposedQuery" class="membertitle">getComposedQuery</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>getComposedQuery</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the query composed with filters and sort criterias. </dd> <dt><b>Returns</b></dt> <dd>the composed query </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getFilter" class="membertitle">getFilter</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>getFilter</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the currently used filter. </dd> <dd><p> The filter criteria returned is part of the where condition of the select command, but it does not contain the where token. </p> </dd> <dt><b>Returns</b></dt> <dd>the filter </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getStructuredFilter" class="membertitle">getStructuredFilter</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< sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> > ></td> </tr> <tr> <td valign="top"><b>getStructuredFilter</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the currently used filter. </dd> <dd><p> The filter criteria is split into levels. Each level represents the OR criterias. Within each level, the filters are provided as an AND criteria with the name of the column and the filter condition. The filter condition is of type string. </p> </dd> <dt><b>Returns</b></dt> <dd>the structured filter </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getOrder" class="membertitle">getOrder</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>getOrder</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the currently used sort order. </dd> <dd><p> The order criteria returned is part of the ORDER BY clause of the select command, but it does not contain the ORDER BY keyword . </p> </dd> <dt><b>Returns</b></dt> <dd>the order </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="appendFilterByColumn" class="membertitle">appendFilterByColumn</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>appendFilterByColumn</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> <td valign="bottom"> column )</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>appends a new filter condition by a <a href="DataColumn.html">DataColumn</a> providing the name and the value for the filter. </dd> <dt><b>Parameter column</b></dt> <dd>the column which is used to create a filter </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::sdbc::SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="appendOrderByColumn" class="membertitle">appendOrderByColumn</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>appendOrderByColumn</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> <td valign="bottom"> column,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> ascending )</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>appends an additional part to the sort order criteria of the select statement. </dd> <dt><b>Parameter column</b></dt> <dd>the column which is used to create a order part </dd> <dt><b>Parameter ascending</b></dt> <dd><b>true</b> when the order should be ascending, otherwise <b>false</b> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::sdbc::SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setFilter" class="membertitle">setFilter</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>setFilter</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> filter )</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>makes it possible to set a filter condition for the query. </dd> <dt><b>Parameter filter</b></dt> <dd>the filter to set </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::sdbc::SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setOrder" class="membertitle">setOrder</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>setOrder</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> order )</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>makes it possibile to set a sort condition for the query. </dd> <dt><b>Parameter order</b></dt> <dd>the order part to set </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::sdbc::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
>
5097
