identifies a XReportEngine which allows the creation of OpenDocument files. More...

import"XReportEngine.idl";

Inheritance diagram for XReportEngine:

Exported Interfaces
interface	com::sun::star::lang::XComponent
	allows life-time control of report engine. More...

interface	com::sun::star::beans::XPropertySet
	gives access to the properties. More...

Public Member Functions
com::sun::star::frame::XModel	createDocumentModel () raises ( ::com::sun::star::lang::DisposedException, com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::Exception )
	creates a report document. More...

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 )
	creates a report document. More...

com::sun::star::util::URL	createDocument () raises ( ::com::sun::star::lang::DisposedException, com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::Exception )
	creates a report document. More...

void	interrupt () raises ( ::com::sun::star::lang::DisposedException, ::com::sun::star::uno::Exception )
	allows to interrupt the creation process of the report document. More...

Public Member Functions inherited from XComponent
void	dispose ()
	The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...

void	addEventListener ([in] XEventListener xListener)
	adds an event listener to the object. More...

void	removeEventListener ([in] XEventListener aListener)
	removes an event listener from the listener list. More...

Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...

void	acquire ()
	increases the reference counter by one. More...

void	release ()
	decreases the reference counter by one. More...

Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo	getPropertySetInfo ()

void	setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the value of the property with the specified name. More...

any	getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )

void	addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XPropertyChangeListener to the specified property. More...

void	removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XPropertyChangeListener from the listener list. More...

void	addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XVetoableChangeListener to the specified property with the name PropertyName. More...

void	removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XVetoableChangeListener from the listener list. More...

Public Attributes
XReportDefinition	ReportDefinition { set raises(com::sun::star::lang::IllegalArgumentException); }
	specifies the report definition object which is used to create the resulting report. More...

com::sun::star::sdbc::XConnection	ActiveConnection { set raises(com::sun::star::lang::IllegalArgumentException); }
	specifies the active connection which is used to create the resulting report. More...

com::sun::star::task::XStatusIndicator	StatusIndicator
	specifies the status indicator which shows the progress of the report generation process. More...

long	MaxRows
	defines the maximum number of rows which should be fetched for the report. More...

Detailed 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

Exported Interfaces

◆ com::sun::star::beans::XPropertySet

interface com::sun::star::beans::XPropertySet

gives access to the properties.

◆ com::sun::star::lang::XComponent

interface com::sun::star::lang::XComponent

allows life-time control of report engine.

Member Function Documentation

◆ createDocument()

com::sun::star::util::URL createDocument	(		)
raises	(	::com::sun::star::lang::DisposedException,
		com::sun::star::lang::IllegalArgumentException,
		::com::sun::star::uno::Exception
	)

creates a report document.

Returns: The URL where the new document is located.

Exceptions

com::sun::star::lang::DisposedException	If the report engine is already disposed.
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
	)

creates a report document.

Parameters

frame The frame must have a controller set. This controller will be set at the model.

Exceptions

com::sun::star::lang::DisposedException	If the report engine is already disposed.
com::sun::star::lang::IllegalArgumentException	If the report definition was not set or is `NULL`.

OJ: Has to be discussed if this method is useful.

◆ createDocumentModel()

com::sun::star::frame::XModel createDocumentModel	(		)
raises	(	::com::sun::star::lang::DisposedException,
		com::sun::star::lang::IllegalArgumentException,
		::com::sun::star::uno::Exception
	)

creates a report document.

Exceptions

com::sun::star::lang::DisposedException	If the report engine is already disposed.
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
	)

allows to interrupt the creation process of the report document.

Exceptions

com::sun::star::lang::DisposedException If the report engine is already disposed.

Member Data Documentation

◆ ActiveConnection

com::sun::star::sdbc::XConnection ActiveConnection
set raises	(	com::sun::star::lang::IllegalArgumentException
	)

attributebound

specifies the active connection which is used to create the resulting report.

◆ MaxRows

long MaxRows

attributebound

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.

◆ ReportDefinition

XReportDefinition ReportDefinition
set raises	(	com::sun::star::lang::IllegalArgumentException
	)

attributebound

specifies the report definition object which is used to create the resulting report.

◆ StatusIndicator

com::sun::star::task::XStatusIndicator StatusIndicator

attribute

specifies the status indicator which shows the progress of the report generation process.

The documentation for this interface was generated from the following file:

com/sun/star/report/XReportEngine.idl

Exported Interfaces

Public Member Functions

Public Attributes

Detailed Description

Exported Interfaces

◆ com::sun::star::beans::XPropertySet

◆ com::sun::star::lang::XComponent

Member Function Documentation

◆ createDocument()

◆ createDocumentAlive()

◆ createDocumentModel()

◆ interrupt()

Member Data Documentation

◆ ActiveConnection

◆ MaxRows

◆ ReportDefinition

◆ StatusIndicator