Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: report ::

interface XReportEngine
Base Interfaces
XReportEngine
┣ ::com::sun::star::lang::XComponent
┗ ::com::sun::star::beans::XPropertySet

::com::sun::star::lang::XComponent
Description
allows life-time control of report engine.
::com::sun::star::beans::XPropertySet
Description
gives access to the properties.
Description
identifies a XReportEngine which allows the creation of OpenDocument files.

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.

See also
com.sun.star.document.OfficeDocument

Methods' Summary
createDocumentModel creates a report document.  
createDocumentAlive creates a report document.  
createDocument creates a report document.  
interrupt allows to interrupt the creation process of the report document.  
Attributes' Summary
ReportDefinition specifies the report definition object which is used to create the resulting report.  
ActiveConnection specifies the active connection which is used to create the resulting report.  
StatusIndicator specifies the status indicator which shows the progress of the report generation process.  
MaxRows defines the maximum number of rows which should be fetched for the report. If the limit is exceeded, the excess rows are silently dropped.
There is no limitation, if set to zero.  
Methods' Details
createDocumentModel
::com::sun::star::frame::XModel
createDocumentModel()
raises( ::com::sun::star::lang::DisposedException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::uno::Exception );

Description
creates a report document.
Throws
::com::sun::star::lang::DisposedException If the report engine is already disposed.
Throws
::com::sun::star::lang::IllegalArgumentException If the report definition was not set or is NULL.
createDocumentAlive
::com::sun::star::frame::XModel
createDocumentAlive( [in] ::com::sun::star::frame::XFrame  frame )
raises( ::com::sun::star::lang::DisposedException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::uno::Exception );

Description
creates a report document.
Parameter _frame
The frame must have a controller set. This controller will be set at the model.
Throws
::com::sun::star::lang::DisposedException If the report engine is already disposed.
Throws
::com::sun::star::lang::IllegalArgumentException If the report definition was not set or is NULL. OJ: Has to be discussed if this method is usefull.
createDocument
::com::sun::star::util::URL
createDocument()
raises( ::com::sun::star::lang::DisposedException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::uno::Exception );

Description
creates a report document.
Returns
The URL where the new document is located.
Throws
::com::sun::star::lang::DisposedException If the report engine is already disposed.
Throws
::com::sun::star::lang::IllegalArgumentException If the report definition was not set or is NULL.
interrupt
void
interrupt()
raises( ::com::sun::star::lang::DisposedException,
::com::sun::star::uno::Exception );

Description
allows to interrupt the creation process of the report document.
Throws
::com::sun::star::lang::DisposedException If the report engine is already disposed.
Attributes' Details
ReportDefinition
[ bound ] XReportDefinition ReportDefinition
set raises (::com::sun::star::lang::IllegalArgumentException);

Description
specifies the report definition object which is used to create the resulting report.
ActiveConnection
[ bound ] ::com::sun::star::sdbc::XConnection ActiveConnection
set raises (::com::sun::star::lang::IllegalArgumentException);

Description
specifies the active connection which is used to create the resulting report.
StatusIndicator
::com::sun::star::task::XStatusIndicator StatusIndicator;
Description
specifies the status indicator which shows the progress of the report generation process.
MaxRows
[ bound ] long MaxRows;
Description
defines the maximum number of rows which should be fetched for the report. If the limit is exceeded, the excess rows are silently dropped.
There is no limitation, if set to zero.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.