<html> <head> <title>Interface XReportEngine</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="XReportEngine-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="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></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">report</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 XReportEngine</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XReportEngine</strong> ┣ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a> ┗ ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows life-time control of report engine. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>gives access to the properties. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>identifies a <a href="XReportEngine.html">XReportEngine</a> which allows the creation of OpenDocument files. </dd> <dd><p>The following events are supported by the report engine. OnPageStarted Is fired when a new page started. OnReportStarted Is fired when a new report started. OnGroupStarted Is fired when a new group started. OnGroupEnded Is fired when the group ended. OnReportEnded Is fired when the report ended. OnPageEnded Is fired when the page ended. </dd> <dt><b>See also</b></dt> <dd><a href="XReportEngine.html#com.sun.star.document.OfficeDocument">com.sun.star.document.OfficeDocument</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="#createDocumentModel">createDocumentModel</a></td> <td class="imsum_right">creates a report document. </td> </tr> <tr> <td class="imsum_left"><a href="#createDocumentAlive">createDocumentAlive</a></td> <td class="imsum_right">creates a report document. </td> </tr> <tr> <td class="imsum_left"><a href="#createDocument">createDocument</a></td> <td class="imsum_right">creates a report document. </td> </tr> <tr> <td class="imsum_left"><a href="#interrupt">interrupt</a></td> <td class="imsum_right">allows to interrupt the creation process of the report document. </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#ReportDefinition">ReportDefinition</a></td> <td class="imsum_right">specifies the report definition object which is used to create the resulting report. </td> </tr> <tr> <td class="imsum_left"><a href="#ActiveConnection">ActiveConnection</a></td> <td class="imsum_right">specifies the active connection which is used to create the resulting report. </td> </tr> <tr> <td class="imsum_left"><a href="#StatusIndicator">StatusIndicator</a></td> <td class="imsum_right">specifies the status indicator which shows the progress of the report generation process. </td> </tr> <tr> <td class="imsum_left"><a href="#MaxRows">MaxRows</a></td> <td class="imsum_right">defines the maximum number of rows which should be fetched for the report. If the limit is exceeded, the excess rows are silently dropped. <br/> There is no limitation, if set to zero. </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="createDocumentModel" class="membertitle">createDocumentModel</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="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a></td> </tr> <tr> <td valign="top"><b>createDocumentModel</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/DisposedException.html">DisposedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a report document. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/DisposedException.html">DisposedException</a> If the report engine is already disposed. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> If the report definition was not set or is <b>NULL</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createDocumentAlive" class="membertitle">createDocumentAlive</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="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a></td> </tr> <tr> <td valign="top"><b>createDocumentAlive</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XFrame.html">XFrame</a></td> <td valign="bottom"> frame )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/DisposedException.html">DisposedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a report document. </dd> <dt><b>Parameter _frame</b></dt> <dd>The frame must have a controller set. This controller will be set at the model. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/DisposedException.html">DisposedException</a> If the report engine is already disposed. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> If the report definition was not set or is <b>NULL</b>. OJ: Has to be discussed if this method is useful. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createDocument" class="membertitle">createDocument</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="../util/module-ix.html">util</a>::<a href="../util/URL.html">URL</a></td> </tr> <tr> <td valign="top"><b>createDocument</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/DisposedException.html">DisposedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a report document. </dd> <dt><b>Returns</b></dt> <dd>The URL where the new document is located. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/DisposedException.html">DisposedException</a> If the report engine is already disposed. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> If the report definition was not set or is <b>NULL</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="interrupt" class="membertitle">interrupt</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>interrupt</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/DisposedException.html">DisposedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>allows to interrupt the creation process of the report document. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/DisposedException.html">DisposedException</a> If the report engine is already disposed. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="ReportDefinition" class="membertitle">ReportDefinition</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] <a href="XReportDefinition.html">XReportDefinition</a> <b>ReportDefinition</b><dl> <dd>set raises (::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies the report definition object which is used to create the resulting report. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ActiveConnection" class="membertitle">ActiveConnection</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XConnection.html">XConnection</a> <b>ActiveConnection</b><dl> <dd>set raises (::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies the active connection which is used to create the resulting report. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="StatusIndicator" class="membertitle">StatusIndicator</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XStatusIndicator.html">XStatusIndicator</a> <b>StatusIndicator</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the status indicator which shows the progress of the report generation process. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MaxRows" class="membertitle">MaxRows</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] long <b>MaxRows</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>defines the maximum number of rows which should be fetched for the report. If the limit is exceeded, the excess rows are silently dropped. <br/> There is no limitation, if set to zero. </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>
