com.elasticpath.cmweb.reportservice
Interface BirtReportService

All Superinterfaces:

EpService

All Known Implementing Classes:

BirtReportServiceImpl

public interface BirtReportService
extends EpService

This service provides access to the birt reporting engine.

Method Summary

void	csvToStream(java.lang.String reportName, int sessionId, java.util.Map params, java.io.OutputStream out) Renders report as csv and outputs to stream.
void	deleteOldDocuments() Deletes old documents from the document dir older than 1 day.
java.lang.String	getHtml(java.lang.String reportName, int sessionId, java.lang.Long pageNumber, java.util.Map params) Returns html for specified report page.
java.util.List	getParameters(java.lang.String reportName) Returns a List of report parameters.
void	initializeOnce(javax.servlet.ServletContext servletContext) Initialized the birt engine.
void	pdfToStream(java.lang.String reportName, java.util.Map params, java.io.OutputStream out) Renders report as pdf and outputs to stream.
void	shutDown() Shutdown the birt engine.

Methods inherited from interface com.elasticpath.service.EpService

getElasticPath, setElasticPath

Method Detail

csvToStream

void csvToStream(java.lang.String reportName,
                 int sessionId,
                 java.util.Map params,
                 java.io.OutputStream out)

Renders report as csv and outputs to stream.

Parameters:

reportName - name of report.

sessionId - unique id for each user.

params - map of param names and values.

out - output stream.

deleteOldDocuments

void deleteOldDocuments()

Deletes old documents from the document dir older than 1 day.

getHtml

java.lang.String getHtml(java.lang.String reportName,
                         int sessionId,
                         java.lang.Long pageNumber,
                         java.util.Map params)

Returns html for specified report page.

Parameters:

reportName - name of report.

sessionId - unique id for each user.

pageNumber - page # to display.

params - map of param names and values.

Returns:

html.

getParameters

java.util.List getParameters(java.lang.String reportName)

Returns a List of report parameters.

Parameters:

reportName - name of report.

Returns:

a List of report parameters.

initializeOnce

void initializeOnce(javax.servlet.ServletContext servletContext)

Initialized the birt engine.

Parameters:

servletContext - servlet context for PlatformServletContext.

pdfToStream

void pdfToStream(java.lang.String reportName,
                 java.util.Map params,
                 java.io.OutputStream out)

Renders report as pdf and outputs to stream.

Parameters:

reportName - name of report.

params - map of param names and values.

out - output stream.

shutDown

void shutDown()

Shutdown the birt engine.