com.haulmont.reports

Interface ReportingApi

All Known Implementing Classes:

ReportingBean

public interface ReportingApi

API for reporting

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
com.haulmont.yarg.reporting.ReportOutputDocument	bulkPrint(Report report, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> paramsList)
com.haulmont.yarg.reporting.ReportOutputDocument	bulkPrint(Report report, java.lang.String templateCode, ReportOutputType outputType, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> paramsList)
void	cancelReportExecution(java.util.UUID userSessionId, java.util.UUID reportId) Cancel report execution
Report	convertToReport(java.lang.String xml)
java.lang.String	convertToString(Report report)
Report	copyReport(Report source)
com.haulmont.cuba.core.entity.FileDescriptor	createAndSaveReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String fileName)
com.haulmont.cuba.core.entity.FileDescriptor	createAndSaveReport(Report report, ReportTemplate template, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String fileName)
com.haulmont.cuba.core.entity.FileDescriptor	createAndSaveReport(Report report, java.lang.String templateCode, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String fileName)
com.haulmont.yarg.reporting.ReportOutputDocument	createReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params)
com.haulmont.yarg.reporting.ReportOutputDocument	createReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params, ReportOutputType outputType)
com.haulmont.yarg.reporting.ReportOutputDocument	createReport(Report report, ReportTemplate template, java.util.Map<java.lang.String,java.lang.Object> params)
com.haulmont.yarg.reporting.ReportOutputDocument	createReport(Report report, java.lang.String templateCode, java.util.Map<java.lang.String,java.lang.Object> params)
com.haulmont.yarg.reporting.ReportOutputDocument	createReport(Report report, java.lang.String templateCode, java.util.Map<java.lang.String,java.lang.Object> params, ReportOutputType outputType)
java.util.Date	currentDateOrTime(ParameterType parameterType) Get current date Date according to ParameterType value
byte[]	exportReports(java.util.Collection<Report> reports)
com.haulmont.chile.core.model.MetaClass	findMetaClassByDataSetEntityAlias(java.lang.String alias, DataSetType dataSetType, java.util.List<ReportInputParameter> reportInputParameters)
java.lang.String	generateReportName(java.lang.String sourceName)
java.util.Collection<Report>	importReports(byte[] zipBytes)
java.util.Collection<Report>	importReports(byte[] zipBytes, java.util.EnumSet<ReportImportOption> importOptions)
ReportImportResult	importReportsWithResult(byte[] zipBytes, java.util.EnumSet<ReportImportOption> importOptions)
java.util.List	loadDataForParameterPrototype(ParameterPrototype prototype)
<T extends com.haulmont.cuba.core.entity.Entity> T	reloadEntity(T entity, com.haulmont.cuba.core.global.View view)
Report	storeReportEntity(Report report)

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

storeReportEntity

Report storeReportEntity(Report report)

createReport

com.haulmont.yarg.reporting.ReportOutputDocument createReport(Report report,
                                                              java.util.Map<java.lang.String,java.lang.Object> params)

createReport

com.haulmont.yarg.reporting.ReportOutputDocument createReport(Report report,
                                                              java.util.Map<java.lang.String,java.lang.Object> params,
                                                              ReportOutputType outputType)

createReport

com.haulmont.yarg.reporting.ReportOutputDocument createReport(Report report,
                                                              java.lang.String templateCode,
                                                              java.util.Map<java.lang.String,java.lang.Object> params)

createReport

com.haulmont.yarg.reporting.ReportOutputDocument createReport(Report report,
                                                              java.lang.String templateCode,
                                                              java.util.Map<java.lang.String,java.lang.Object> params,
                                                              ReportOutputType outputType)

createReport

com.haulmont.yarg.reporting.ReportOutputDocument createReport(Report report,
                                                              ReportTemplate template,
                                                              java.util.Map<java.lang.String,java.lang.Object> params)

createAndSaveReport

com.haulmont.cuba.core.entity.FileDescriptor createAndSaveReport(Report report,
                                                                 java.util.Map<java.lang.String,java.lang.Object> params,
                                                                 java.lang.String fileName)

createAndSaveReport

com.haulmont.cuba.core.entity.FileDescriptor createAndSaveReport(Report report,
                                                                 java.lang.String templateCode,
                                                                 java.util.Map<java.lang.String,java.lang.Object> params,
                                                                 java.lang.String fileName)

createAndSaveReport

com.haulmont.cuba.core.entity.FileDescriptor createAndSaveReport(Report report,
                                                                 ReportTemplate template,
                                                                 java.util.Map<java.lang.String,java.lang.Object> params,
                                                                 java.lang.String fileName)

exportReports

byte[] exportReports(java.util.Collection<Report> reports)

importReports

java.util.Collection<Report> importReports(byte[] zipBytes)

importReports

java.util.Collection<Report> importReports(byte[] zipBytes,
                                           java.util.EnumSet<ReportImportOption> importOptions)

importReportsWithResult

ReportImportResult importReportsWithResult(byte[] zipBytes,
                                           java.util.EnumSet<ReportImportOption> importOptions)

convertToString

java.lang.String convertToString(Report report)

convertToReport

Report convertToReport(java.lang.String xml)

copyReport

Report copyReport(Report source)

bulkPrint

com.haulmont.yarg.reporting.ReportOutputDocument bulkPrint(Report report,
                                                           java.util.List<java.util.Map<java.lang.String,java.lang.Object>> paramsList)

bulkPrint

com.haulmont.yarg.reporting.ReportOutputDocument bulkPrint(Report report,
                                                           java.lang.String templateCode,
                                                           ReportOutputType outputType,
                                                           java.util.List<java.util.Map<java.lang.String,java.lang.Object>> paramsList)

reloadEntity

<T extends com.haulmont.cuba.core.entity.Entity> T reloadEntity(T entity,
                                                                com.haulmont.cuba.core.global.View view)

findMetaClassByDataSetEntityAlias

com.haulmont.chile.core.model.MetaClass findMetaClassByDataSetEntityAlias(java.lang.String alias,
                                                                          DataSetType dataSetType,
                                                                          java.util.List<ReportInputParameter> reportInputParameters)

generateReportName

java.lang.String generateReportName(java.lang.String sourceName)

loadDataForParameterPrototype

java.util.List loadDataForParameterPrototype(ParameterPrototype prototype)

cancelReportExecution

void cancelReportExecution(java.util.UUID userSessionId,
                           java.util.UUID reportId)

Cancel report execution

Parameters:

userSessionId - - user session that started report execution

reportId - - identifier of executed report

currentDateOrTime

java.util.Date currentDateOrTime(ParameterType parameterType)

Get current date Date according to ParameterType value

Parameters:

parameterType - - ParameterType value.

Returns:

adjusted Date