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