org.nuxeo.ecm.platform.reporting.api

Interface ReportInstance

All Known Implementing Classes:

BirtReportInstance

public interface ReportInstance

Represents a report instance that is bound to a model. This interface holds the main methods for managing report parameter and running the rendering.

Author:

Tiry (tdelprat@nuxeo.com)

Method Summary

Methods

Modifier and Type	Method and Description
DocumentModel	getDoc() Gives access to the underlying DocumentModel
ReportModel	getModel() Return the associated ReportModel
String	getReportKey() Get the key used to uniquely identify the report instance This key is used in REST urls.
List<ReportParameter>	getReportParameters() Get All reports parameters : merging model parameters with instance parameters
List<ReportParameter>	getReportUserParameters() Get report parameters that can be entered by the user.
Map<String,String>	getStoredParameters() Get parameters as storef in thi resport instance
void	initParameterList() Initialize the parameters from the associated model
void	render(org.eclipse.birt.report.engine.api.IRenderOption options, Map<String,Object> parameters) Starts the rendering of the report according to IRenderOption
void	setParameter(ReportParameter param) Sets a parameter
void	setParameter(String name, Object value) Sets a parameter
void	setReportKey(String key) Sets the report key (used from a Core Listener)

Method Detail

getModel

ReportModel getModel()
                     throws ClientException

Return the associated ReportModel

Returns:

Throws:

ClientException

getReportUserParameters

List<ReportParameter> getReportUserParameters()
                                              throws Exception

Get report parameters that can be entered by the user. This is used to generate the parameter form at rendering time.

Returns:

Throws:

Exception

getReportParameters

List<ReportParameter> getReportParameters()
                                          throws Exception

Get All reports parameters : merging model parameters with instance parameters

Returns:

Throws:

Exception

getStoredParameters

Map<String,String> getStoredParameters()
                                       throws ClientException

Get parameters as storef in thi resport instance

Returns:

Throws:

ClientException

setParameter

void setParameter(ReportParameter param)
                  throws Exception

Sets a parameter

Parameters:

param -

Throws:

Exception

setParameter

void setParameter(String name,
                Object value)
                  throws Exception

Sets a parameter

Parameters:

name -

value -

Throws:

Exception

render

void render(org.eclipse.birt.report.engine.api.IRenderOption options,
          Map<String,Object> parameters)
            throws Exception

Starts the rendering of the report according to IRenderOption

Parameters:

options -

parameters -

Throws:

Exception

getDoc

DocumentModel getDoc()

Gives access to the underlying DocumentModel

Returns:

getReportKey

String getReportKey()

Get the key used to uniquely identify the report instance This key is used in REST urls.

Returns:

setReportKey

void setReportKey(String key)
                  throws ClientException

Sets the report key (used from a Core Listener)

Parameters:

key -

Throws:

ClientException

initParameterList

void initParameterList()
                       throws Exception

Initialize the parameters from the associated model

Throws:

Exception