de.hybris.platform.cockpit.reports

Interface JasperMediaService

All Known Implementing Classes:

DefaultJasperMediaService

public interface JasperMediaService

Service to manipulate report medias.

Spring Bean ID:

jasperMediaService

Method Summary

Modifier and Type	Method and Description
JasperMediaModel	createJasperMedia(MediaFolderModel folder, java.lang.String code) Creates JasperMedia from given paramters.
JasperWidgetPreferencesModel	createJasperWidgetPreferencesFromMedia(JasperReport compiledReport, JasperMediaModel media, UserModel user) Creates JasperWidgetPreferencesModel and adds parameters to it.
JasperMediaModel	getJasperMediaForCode(java.lang.String code) Return media for a specific code.
MediaFolderModel	getJasperReportsMediaFolder() Returns folder where Jasper Report medias are stored in.
JasperReport	getReportFromMedia(MediaModel media) Creates compiled report from JRXML file
CompiledJasperMediaModel	setCompiledCounterpartForMedia(CompiledJasperMediaModel jasperMedia) Sets compiled report for media.

Method Detail

getJasperReportsMediaFolder

MediaFolderModel getJasperReportsMediaFolder()

Returns folder where Jasper Report medias are stored in.

createJasperMedia

JasperMediaModel createJasperMedia(MediaFolderModel folder,
                                   java.lang.String code)

Creates JasperMedia from given paramters.

Parameters:

folder - for media

code - for media

Returns:

created, but not stored in database media instance

setCompiledCounterpartForMedia

CompiledJasperMediaModel setCompiledCounterpartForMedia(CompiledJasperMediaModel jasperMedia)
                                                 throws JRException

Sets compiled report for media. Does not save it in database.

Parameters:

jasperMedia - media for which compiled version will be set

Throws:

JRException

getReportFromMedia

JasperReport getReportFromMedia(MediaModel media)
                         throws JasperReportLoadException

Creates compiled report from JRXML file

Parameters:

media - from which report is created

Returns:

compiled report

Throws:

JasperReportLoadException

getJasperMediaForCode

JasperMediaModel getJasperMediaForCode(java.lang.String code)

Return media for a specific code. Code is unique for media.

createJasperWidgetPreferencesFromMedia

JasperWidgetPreferencesModel createJasperWidgetPreferencesFromMedia(JasperReport compiledReport,
                                                                    JasperMediaModel media,
                                                                    UserModel user)

Creates JasperWidgetPreferencesModel and adds parameters to it. Does not save created item.

Parameters:

compiledReport - from which parameters are taken

media - contained JRXML file

user - owner of the item

Returns:

created, but not saved item