org.bonitasoft.engine.api

Interface ReportingAPI

public interface ReportingAPI

Author:

Matthieu Chaffotte, Celine Souchet

Method Summary

Methods

Modifier and Type	Method and Description
Report	getReport(long reportId)
byte[]	getReportContent(long reportId)
SearchResult<Report>	searchReports(SearchOptions searchOptions)
String	selectList(String selectQuery) Executes a SELECT query (rollback only) and returns the result in a CSV format.

Method Detail

selectList

String selectList(String selectQuery)
                  throws ExecutionException

Executes a SELECT query (rollback only) and returns the result in a CSV format.

If the query is not a SELECT one a RetrieveException is thrown.

Parameters:

selectQuery - the SELECT query.

Returns:

the result of the query in a CSV format.

Throws:

ExecutionException - if an exception occurs during the execution of the query.

getReport

Report getReport(long reportId)
                 throws ReportNotFoundException

Throws:

ReportNotFoundException

getReportContent

byte[] getReportContent(long reportId)
                        throws ReportNotFoundException

Throws:

ReportNotFoundException

searchReports

SearchResult<Report> searchReports(SearchOptions searchOptions)
                                   throws SearchException

Throws:

SearchException