offapi/com/sun/star/report/XReportDefinition.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: XReportDefinition.idl,v $
  10  * $Revision: 1.4 $
  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_XReportDefinition_idl__
  31 #define __com_sun_star_report_XReportDefinition_idl__
  32
  33 #ifndef __com_sun_star_report_XReportComponent_idl__
  34 #include <com/sun/star/report/XReportComponent.idl>
  35 #endif
  36 #ifndef __com_sun_star_report_XFunctionsSupplier_idl__
  37 #include <com/sun/star/report/XFunctionsSupplier.idl>
  38 #endif
  39 #ifndef __com_sun_star_view_PaperOrientation_idl__
  40 #include <com/sun/star/view/PaperOrientation.idl>
  41 #endif
  42 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  43 #include <com/sun/star/container/NoSuchElementException.idl>
  44 #endif
  45 #ifndef __com_sun_star_style_GraphicLocation_idl__
  46 #include <com/sun/star/style/GraphicLocation.idl>
  47 #endif
  48 #ifndef __com_sun_star_view_PaperFormat_idl__
  49 #include <com/sun/star/view/PaperFormat.idl>
  50 #endif
  51 #ifndef __com_sun_star_util_XClosable_idl__
  52 #include <com/sun/star/util/XCloseable.idl>
  53 #endif
  54 #ifndef __com_sun_star_ui_XUIConfigurationManagerSupplier_idl__
  55 #include <com/sun/star/ui/XUIConfigurationManagerSupplier.idl>
  56 #endif
  57 #ifndef __com_sun_star_document_XDocumentSubStorageSupplier_idl__
  58 #include <com/sun/star/document/XDocumentSubStorageSupplier.idl>
  59 #endif
  60 #ifndef __com_sun_star_frame_XModel_idl__
  61 #include <com/sun/star/frame/XModel.idl>
  62 #endif
  63 #ifndef __com_sun_star_document_XViewDataSupplier_idl__
  64 #include <com/sun/star/document/XViewDataSupplier.idl>
  65 #endif
  66 #ifndef __com_sun_star_frame_XLoadable_idl__
  67 #include <com/sun/star/frame/XLoadable.idl>
  68 #endif
  69 #ifndef __com_sun_star_embed_XVisualObject_idl__
  70 #include <com/sun/star/embed/XVisualObject.idl>
  71 #endif
  72 #ifndef __com_sun_star_embed_XStorageBasedDocument_idl__
  73 #include <com/sun/star/document/XStorageBasedDocument.idl>
  74 #endif
  75 #ifndef __com_sun_star_awt_Size_idl__
  76 #include <com/sun/star/awt/Size.idl>
  77 #endif
  78 #ifndef __com_sun_star_util_XModifiable_idl__
  79 #include <com/sun/star/util/XModifiable.idl>
  80 #endif
  81 #ifndef __com_sun_star_document_XEventBroadcaster_idl__
  82 #include <com/sun/star/document/XEventBroadcaster.idl>
  83 #endif
  84 #ifndef __com_sun_star_lang_DisposedException_idl__
  85 #include <com/sun/star/lang/DisposedException.idl>
  86 #endif
  87 #ifndef __com_sun_star_style_XStyleFamiliesSupplier_idl__
  88 #include <com/sun/star/style/XStyleFamiliesSupplier.idl>
  89 #endif
  90
  91 module com {  module sun {  module star {  module sdbc {
  92 published interface XConnection;
  93 };};};};
  94 //=============================================================================
  95
  96  module com {  module sun {  module star {  module report {
  97
  98      interface XSection;
  99      interface XGroups;
 100 //=============================================================================
 101
 102 /** identifies a <type>XReportComponent</type> as being a (sub-) report.
 103
 104     <p>This interface does not really provide an own functionality, it is only for easier
 105     runtime identification of report components.</p>
 106
 107     <p>A report fulfills several tasks, like storing the structure of its
 108     report components and it provides the
 109     event environment for its contained elements.</p>
 110
 111     @see XReportComponent
 112  */
 113 interface XReportDefinition
 114 {
 115     /** allows the access to the model embedded in the database storage.
 116     */
 117     interface com::sun::star::frame::XModel;
 118
 119     /** offers a simple way to initialize a component.
 120     */
 121     interface com::sun::star::frame::XLoadable;
 122
 123     /** represents common visualisation functionality for the embedded report.
 124     */
 125     interface com::sun::star::embed::XVisualObject;
 126
 127     /** allows to initialize the document with a storage.
 128     */
 129     interface com::sun::star::document::XStorageBasedDocument;
 130
 131     /** gives access to some properties describing all open views to a document.
 132     */
 133     interface com::sun::star::document::XViewDataSupplier;
 134
 135     /** allows to close the document.
 136     */
 137     interface com::sun::star::util::XCloseable;
 138
 139     /** allows to retrieve the user interface configuration manager related to an object.
 140     */
 141     interface com::sun::star::ui::XUIConfigurationManagerSupplier;
 142
 143     interface com::sun::star::document::XDocumentSubStorageSupplier;
 144
 145     /** provides access to the collection of style families.
 146
 147         <p>A spreadsheet document contains 2 families of styles:
 148         "PageStyles" and "CellStyles".</p>
 149      */
 150     interface com::sun::star::style::XStyleFamiliesSupplier;
 151
 152     //-------------------------------------------------------------------------
 153     /** a storable document should provide information about his modify state
 154
 155         <p>
 156         With this interface it's possible too, to reset the modify state.
 157         That can be neccessary to prevent code against problem during closing
 158         of the document without saving any changes.
 159         </p>
 160      */
 161     interface com::sun::star::util::XModifiable;
 162
 163     /** allows the creation of sub reports.
 164     */
 165     interface XReportComponent;
 166
 167     /** gives access to functions defined in the report definition.
 168     */
 169     interface XFunctionsSupplier;
 170
 171     /** makes it possible to register listeners which are called whenever
 172         a document event occurs.
 173         This is a workaround due to the fact that this interface can not be directly inherited from <type scope="com::sun::star::document">XEventBroadcaster</type>
 174         because the methods addEventListener and removeEventListener are already defined in <type scope="com::sun::star::lang">XComponent</type>.
 175         A queryInterface call is still supported to the <type scope="com::sun::star::document">XEventBroadcaster</type> interface.
 176      */
 177     com::sun::star::document::XEventBroadcaster getEventBroadcaster()
 178         raises( ::com::sun::star::lang::DisposedException,
 179                 ::com::sun::star::uno::Exception );
 180
 181     /** returns a sequence of the currently supported output formats.
 182     */
 183     sequence<string> getAvailableMimeTypes()
 184         raises( ::com::sun::star::lang::DisposedException,
 185                 ::com::sun::star::uno::Exception );
 186
 187     //-------------------------------------------------------------------------
 188
 189     /** Represents the output format (media (mime) type) of the resulting document when executing this report.
 190     */
 191     [attribute,bound] string MimeType
 192     {
 193         set raises (com::sun::star::lang::IllegalArgumentException);
 194     };
 195
 196     /** Represents the title of the report in print preview.
 197     */
 198     [attribute,bound] string Caption;
 199
 200     /** Specifies whether groups in a multi column report are kept together.
 201         @see com.sun.star.report.GroupKeepTogether
 202     */
 203     [attribute,bound] short GroupKeepTogether
 204     {
 205         set raises (com::sun::star::lang::IllegalArgumentException);
 206     };
 207
 208     /** Represents the location of the page header.
 209         @see ReportPrintOption
 210     */
 211     [attribute,bound] short PageHeaderOption;
 212
 213     /** Represents the location of the page footer.
 214         @see ReportPrintOption
 215     */
 216     [attribute,bound] short PageFooterOption;
 217
 218
 219     /** is the command which should be executed, the type of command depends
 220     on the CommandType.
 221     <p>In case of a <member>CommandType</member> of <member>CommandType::COMMAND</member>,
 222     means in case the <member>Command</member> specifies an SQL statement, the inherited
 223     <member scope="com::sun::star::sdbc">RowSet::EscapeProcessing</member>
 224     becomes relevant:<br/>
 225     It then can be to used to specify whether the SQL statement should be analyzed on the
 226     client side before sending it to the database server.<br/>
 227     The default value for <member scope="com::sun::star::sdbc">RowSet::EscapeProcessing</member>
 228     is <TRUE/>. By switching it to <FALSE/>, you can pass backend-specific SQL statements,
 229     which are not standard SQL, to your database.</p>
 230
 231
 232     @see com::sun::star::sdb::CommandType
 233     */
 234     [attribute,bound] string Command;
 235
 236     /** specifies the type of the command to be executed to retrieve a result set.
 237
 238         <p><member>Command</member> needs to be interpreted depending on the value of this property.</p>
 239
 240         <p>This property is only meaningfull together with the <member>Command</member>
 241         property, thus either <em>both</em> or <em>none</em> of them are present.</p>
 242
 243         @see com::sun::star::sdb::CommandType
 244      */
 245     [attribute,bound] long CommandType;
 246
 247     /** specifies an addtional filter to optinally use.
 248
 249         <p>The Filter string has to form a SQL WHERE-clause, <em>without</em> the WHERE-string itself.</p>
 250
 251         <p>If a <member>DataSourceName</member>, <member>Command</member> and <member>CommandType</member>
 252         are specified, a <type>RowSet</type> can be created with this information. If the results provided by the
 253         row set are to be additionally filtered, the Filter property can be used.</p>
 254
 255         <p>Note that the Filter property does not make sense if a <member>ResultSet</member> has been specified
 256         in the DataAccessDescriptor.</p>
 257
 258         @see com::sun::star::sdb::RowSet
 259         @see ResultSet
 260     */
 261     [attribute,bound] string Filter;
 262
 263     /** specifies if the <member>Command</member> should be analyzed on the client side before sending it
 264         to the database server.
 265
 266         <p>The default value of this property is <TRUE/>. By switching it to <FALSE/>, you can pass
 267         backend-specific SQL statements, which are not standard SQL, to your database.</p>
 268
 269         <p>This property is usually present together with the <member>Command</member> and
 270         <member>CommandType</member> properties, and is evaluated if and only if <member>CommandType</member>
 271         equals <member>CommandType::COMMAND</member>.</p>
 272     */
 273     [attribute,bound] boolean EscapeProcessing;
 274
 275     /** specifies the active connection which is used to create the resulting report.
 276     */
 277     [attribute,bound] com::sun::star::sdbc::XConnection ActiveConnection
 278     {
 279         set raises (com::sun::star::lang::IllegalArgumentException);
 280     };
 281
 282     /** is the name of the datasource to use, this could be a named datasource
 283         or the URL of a data access component.
 284      */
 285     [attribute,bound] string DataSourceName;
 286
 287     /** Defines that the report header is on.
 288         Default is <FALSE/>.
 289     */
 290     [attribute,bound] boolean ReportHeaderOn;
 291
 292     /** Defines that the report footer is on.
 293         Default is <FALSE/>.
 294     */
 295     [attribute,bound] boolean ReportFooterOn;
 296
 297     /** Defines that the page header is on.
 298         Default is <TRUE/>.
 299     */
 300     [attribute,bound] boolean PageHeaderOn;
 301
 302     /** Defines that the page footer is on.
 303         Default is <TRUE/>.
 304     */
 305     [attribute,bound] boolean PageFooterOn;
 306
 307     /** Represents the groups of the report.
 308     */
 309     [attribute,readonly] com::sun::star::report::XGroups Groups;
 310
 311     /** returns the report header if the <member>ReportHeaderOn</member>is <TRUE/>.
 312         @throws <type scope="com::sun::star::container">NoSuchElementException</type>
 313             If the report has the report header disabled.
 314         @see XSection
 315     */
 316     [attribute,readonly] com::sun::star::report::XSection ReportHeader
 317     {
 318         get raises (com::sun::star::container::NoSuchElementException);
 319     };
 320
 321     /** returns the page header if the <member>PageHeaderOn</member>is <TRUE/>.
 322         @throws <type scope="com::sun::star::container">NoSuchElementException</type>
 323             If the report has the page header disabled.
 324         @see XSection
 325     */
 326     [attribute,readonly] com::sun::star::report::XSection PageHeader
 327     {
 328         get raises (com::sun::star::container::NoSuchElementException);
 329     };
 330
 331     /** returns the detail section.
 332         @see XSection
 333     */
 334     [attribute,readonly] com::sun::star::report::XSection Detail;
 335
 336     /** returns the page footer if the <member>PageFooterOn</member>is <TRUE/>.
 337         @throws <type scope="com::sun::star::container">NoSuchElementException</type>
 338             If the report has the page footer disabled.
 339         @see XSection
 340     */
 341     [attribute,readonly] com::sun::star::report::XSection PageFooter
 342     {
 343         get raises (com::sun::star::container::NoSuchElementException);
 344     };
 345
 346     /** returns the report footer if the <member>ReportFooterOn</member>is <TRUE/>.
 347         @throws <type scope="com::sun::star::container">NullPointerException</type>
 348             If the report has the report footer disabled.
 349         @see XSection
 350     */
 351     [attribute,readonly] com::sun::star::report::XSection ReportFooter
 352     {
 353         get raises (com::sun::star::container::NoSuchElementException);
 354     };
 355 };
 356
 357 service ReportDefinition : XReportDefinition;
 358 //=============================================================================
 359
 360 }; }; }; };
 361
 362 /*=============================================================================
 363
 364 =============================================================================*/
 365 #endif