de.hybris.platform.cockpit.services.reports

Interface ReportsService

All Known Implementing Classes:

DefaultReportsService

public interface ReportsService

The interface ReportsService.

Method Summary

Modifier and Type	Method and Description
JasperReport	compileReport(JasperMediaModel jasperMedia)
MediaModel	createCompiledCounterpart(CompiledJasperMediaModel xmlReport) Creates compiled version of given report.
java.util.List<JasperMediaModel>	findJasperMediasByMediaFolder(java.lang.String folderName) Find jasper medias by media folder.
JasperReport	getMainReport(java.lang.String title)
java.util.Map<java.lang.String,java.lang.Object>	getMainReportParameters(java.lang.String title)

Method Detail

getMainReport

JasperReport getMainReport(java.lang.String title)

Parameters:

title - of WidgetPreferencesModel

Returns:

JasperReport assigned to JasperMedia of WidgetPreferencesModel item with given title. If report assigned to found preferences item is not compiled then it's compiled before returning.

getMainReportParameters

java.util.Map<java.lang.String,java.lang.Object> getMainReportParameters(java.lang.String title)

Parameters:

title - of WidgetPreferencesModel

Returns:

Map with parameters of report assigned to WidgetPreferencesModel item with given title. If no preferences object with such title is found, empty map is returned.

compileReport

JasperReport compileReport(JasperMediaModel jasperMedia)

Returns:

compiled report from given JasperMediaModel. If given media is of type CompiledJasperMediaModel then compiled report from this item is returned.

createCompiledCounterpart

MediaModel createCompiledCounterpart(CompiledJasperMediaModel xmlReport)

Creates compiled version of given report.

Parameters:

xmlReport - the xml report

Returns:

the media model

findJasperMediasByMediaFolder

java.util.List<JasperMediaModel> findJasperMediasByMediaFolder(java.lang.String folderName)

Find jasper medias by media folder.

Parameters:

folderName - the folder name

Returns:

the list