1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_report_XReportEngine_idl__
24#define __com_sun_star_report_XReportEngine_idl__
25
26#ifndef __com_sun_star_report_XReportDefinition_idl__
27#include <com/sun/star/report/XReportDefinition.idl>
28#endif
29#ifndef __com_sun_star_beans_XPropertySet_idl__
30#include <com/sun/star/beans/XPropertySet.idl>
31#endif
32#ifndef __com_sun_star_lang_XComponent_idl__
33#include <com/sun/star/lang/XComponent.idl>
34#endif
35#ifndef __com_sun_star_util_URL_idl__
36#include <com/sun/star/util/URL.idl>
37#endif
38#ifndef __com_sun_star_frame_XModel_idl__
39#include <com/sun/star/frame/XModel.idl>
40#endif
41#ifndef __com_sun_star_task_XStatusIndicator_idl__
42#include <com/sun/star/task/XStatusIndicator.idl>
43#endif
44#ifndef __com_sun_star_frame_XFrame_idl__
45#include <com/sun/star/frame/XFrame.idl>
46#endif
47#ifndef __com_sun_star_sdbc_XConnection_idl__
48#include <com/sun/star/sdbc/XConnection.idl>
49#endif
50#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
51#include <com/sun/star/lang/IllegalArgumentException.idl>
52#endif
53#ifndef __com_sun_star_lang_DisposedException_idl__
54#include <com/sun/star/lang/DisposedException.idl>
55#endif
56#ifndef __com_sun_star_uno_Exception_idl__
57#include <com/sun/star/uno/Exception.idl>
58#endif
59
60//=============================================================================
61module com {  module sun {  module star {  module report {
62/** identifies a <type>XReportEngine</type> which allows the creation of OpenDocument files.
63
64    <p>The following events are supported by the report engine.
65        OnPageStarted		Is fired when a new page started.
66        OnReportStarted		Is fired when a new report started.
67        OnGroupStarted		Is fired when a new group started.
68        OnGroupEnded		Is fired when the group ended.
69        OnReportEnded		Is fired when the report ended.
70        OnPageEnded			Is fired when the page ended.
71
72    @see com.sun.star.document.OfficeDocument
73*/
74
75published interface XReportEngine
76{
77    /** allows life-time control of report engine.
78     */
79    interface com::sun::star::lang::XComponent;
80
81    /** gives access to the properties.
82    */
83    interface com::sun::star::beans::XPropertySet;
84
85    /** creates a report document.
86        @throws <type scope="com::sun::star::lang">DisposedException</type>
87            If the report engine is already disposed.
88        @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
89            If the report definition was not set or is <NULL/>.
90    */
91    com::sun::star::frame::XModel createDocumentModel()
92        raises( ::com::sun::star::lang::DisposedException,
93                com::sun::star::lang::IllegalArgumentException,
94                ::com::sun::star::uno::Exception );
95
96    /** creates a report document.
97        @param	_frame
98            The frame must have a controller set. This controller will be set at the model.
99        @throws <type scope="com::sun::star::lang">DisposedException</type>
100            If the report engine is already disposed.
101        @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
102            If the report definition was not set or is <NULL/>.
103
104        OJ: Has to be discussed if this method is usefull.
105    */
106    com::sun::star::frame::XModel createDocumentAlive([in] com::sun::star::frame::XFrame frame)
107        raises( ::com::sun::star::lang::DisposedException,
108                com::sun::star::lang::IllegalArgumentException,
109                ::com::sun::star::uno::Exception );
110
111    /** creates a report document.
112        @return
113            The URL where the new document is located.
114        @throws <type scope="com::sun::star::lang">DisposedException</type>
115            If the report engine is already disposed.
116        @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
117            If the report definition was not set or is <NULL/>.
118    */
119    com::sun::star::util::URL createDocument()
120        raises( ::com::sun::star::lang::DisposedException,
121                com::sun::star::lang::IllegalArgumentException,
122                ::com::sun::star::uno::Exception );
123
124    /** allows to interrupt the creation process of the report document.
125        @throws <type scope="com::sun::star::lang">DisposedException</type>
126            If the report engine is already disposed.
127    */
128    void interrupt()
129        raises( ::com::sun::star::lang::DisposedException,
130                ::com::sun::star::uno::Exception );
131
132    /** specifies the report definition object which is used to create the resulting report.
133    */
134    [attribute,bound] XReportDefinition ReportDefinition
135    {
136        set raises (com::sun::star::lang::IllegalArgumentException);
137    };
138
139    /** specifies the active connection which is used to create the resulting report.
140    */
141    [attribute,bound] com::sun::star::sdbc::XConnection ActiveConnection
142    {
143        set raises (com::sun::star::lang::IllegalArgumentException);
144    };
145
146    /** specifies the status indicator which shows the progress of the report generation process.
147    */
148    [attribute] com::sun::star::task::XStatusIndicator StatusIndicator;
149
150    /** defines the maximum number of rows which should be fetched for the report.
151        If the limit is exceeded, the excess rows are silently dropped.
152        <br/>
153        There is no limitation, if set to zero.
154     */
155    [attribute,bound] long MaxRows;
156};
157
158//=============================================================================
159
160}; }; }; };
161
162/*=============================================================================
163
164=============================================================================*/
165#endif
166