offapi/com/sun/star/report/XReportEngine.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XReportEngine.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_report_XReportEngine_idl__
  31 #define __com_sun_star_report_XReportEngine_idl__
  32
  33 #ifndef __com_sun_star_report_XReportDefinition_idl__
  34 #include <com/sun/star/report/XReportDefinition.idl>
  35 #endif
  36 #ifndef __com_sun_star_beans_XPropertySet_idl__
  37 #include <com/sun/star/beans/XPropertySet.idl>
  38 #endif
  39 #ifndef __com_sun_star_lang_XComponent_idl__
  40 #include <com/sun/star/lang/XComponent.idl>
  41 #endif
  42 #ifndef __com_sun_star_util_URL_idl__
  43 #include <com/sun/star/util/URL.idl>
  44 #endif
  45 #ifndef __com_sun_star_frame_XModel_idl__
  46 #include <com/sun/star/frame/XModel.idl>
  47 #endif
  48 #ifndef __com_sun_star_task_XStatusIndicator_idl__
  49 #include <com/sun/star/task/XStatusIndicator.idl>
  50 #endif
  51 #ifndef __com_sun_star_frame_XFrame_idl__
  52 #include <com/sun/star/frame/XFrame.idl>
  53 #endif
  54 #ifndef __com_sun_star_sdbc_XConnection_idl__
  55 #include <com/sun/star/sdbc/XConnection.idl>
  56 #endif
  57 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  58 #include <com/sun/star/lang/IllegalArgumentException.idl>
  59 #endif
  60 #ifndef __com_sun_star_lang_DisposedException_idl__
  61 #include <com/sun/star/lang/DisposedException.idl>
  62 #endif
  63 #ifndef __com_sun_star_uno_Exception_idl__
  64 #include <com/sun/star/uno/Exception.idl>
  65 #endif
  66
  67 //=============================================================================
  68 module com {  module sun {  module star {  module report {
  69 /** identifies a <type>XReportEngine</type> which allows the creation of OpenDocument files.
  70
  71     <p>The following events are supported by the report engine.
  72         OnPageStarted           Is fired when a new page started.
  73         OnReportStarted         Is fired when a new report started.
  74         OnGroupStarted          Is fired when a new group started.
  75         OnGroupEnded            Is fired when the group ended.
  76         OnReportEnded           Is fired when the report ended.
  77         OnPageEnded                     Is fired when the page ended.
  78
  79     @see com.sun.star.document.OfficeDocument
  80 */
  81
  82 interface XReportEngine
  83 {
  84     /** allows life-time control of report engine.
  85      */
  86     interface com::sun::star::lang::XComponent;
  87
  88     /** gives access to the properties.
  89     */
  90     interface com::sun::star::beans::XPropertySet;
  91
  92     /** creates a report document.
  93         @throws <type scope="com::sun::star::lang">DisposedException</type>
  94             If the report engine is already disposed.
  95         @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
  96             If the report definition was not set or is <NULL/>.
  97     */
  98     com::sun::star::frame::XModel createDocumentModel()
  99         raises( ::com::sun::star::lang::DisposedException,
 100                 com::sun::star::lang::IllegalArgumentException,
 101                 ::com::sun::star::uno::Exception );
 102
 103     /** creates a report document.
 104         @param  _frame
 105             The frame must have a controller set. This controller will be set at the model.
 106         @throws <type scope="com::sun::star::lang">DisposedException</type>
 107             If the report engine is already disposed.
 108         @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
 109             If the report definition was not set or is <NULL/>.
 110
 111         OJ: Has to be discussed if this method is usefull.
 112     */
 113     com::sun::star::frame::XModel createDocumentAlive([in] com::sun::star::frame::XFrame frame)
 114         raises( ::com::sun::star::lang::DisposedException,
 115                 com::sun::star::lang::IllegalArgumentException,
 116                 ::com::sun::star::uno::Exception );
 117
 118     /** creates a report document.
 119         @return
 120             The URL where the new document is located.
 121         @throws <type scope="com::sun::star::lang">DisposedException</type>
 122             If the report engine is already disposed.
 123         @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
 124             If the report definition was not set or is <NULL/>.
 125     */
 126     com::sun::star::util::URL createDocument()
 127         raises( ::com::sun::star::lang::DisposedException,
 128                 com::sun::star::lang::IllegalArgumentException,
 129                 ::com::sun::star::uno::Exception );
 130
 131     /** allows to interrupt the creation process of the report document.
 132         @throws <type scope="com::sun::star::lang">DisposedException</type>
 133             If the report engine is already disposed.
 134     */
 135     void interrupt()
 136         raises( ::com::sun::star::lang::DisposedException,
 137                 ::com::sun::star::uno::Exception );
 138
 139     /** specifies the report definition object which is used to create the resulting report.
 140     */
 141     [attribute,bound] XReportDefinition ReportDefinition
 142     {
 143         set raises (com::sun::star::lang::IllegalArgumentException);
 144     };
 145
 146     /** specifies the active connection which is used to create the resulting report.
 147     */
 148     [attribute,bound] com::sun::star::sdbc::XConnection ActiveConnection
 149     {
 150         set raises (com::sun::star::lang::IllegalArgumentException);
 151     };
 152
 153     /** specifies the status indicator which shows the progress of the report generation process.
 154     */
 155     [attribute] com::sun::star::task::XStatusIndicator StatusIndicator;
 156
 157     /** defines the maximum number of rows which should be fetched for the report.
 158         If the limit is exceeded, the excess rows are silently dropped.
 159         <br/>
 160         There is no limitation, if set to zero.
 161      */
 162     [attribute,bound] long MaxRows;
 163 };
 164
 165 //=============================================================================
 166
 167 }; }; }; };
 168
 169 /*=============================================================================
 170
 171 =============================================================================*/
 172 #endif