de.hybris.platform.cockpit.reports

Interface JasperReportCacheService

All Known Implementing Classes:

DefaultJasperReportCacheService

public interface JasperReportCacheService

Session-scoped service that caches reports

Spring Bean ID:

jasperReportCacheService

Method Summary

Modifier and Type	Method and Description
JasperReport	getCompiledReport(JasperWidgetPreferencesModel widget) Returns cached report.
AImage	getImageForJasperWidgetPreferences(JasperWidgetPreferencesModel widget) Returns cached image for widget.
void	invalidateAll() Clears cache
boolean	remove(JasperWidgetPreferencesModel widget) Removes widget from cache.
boolean	update(JasperWidgetPreferencesModel widget) Updates cached report for specific widget.

Method Detail

remove

boolean remove(JasperWidgetPreferencesModel widget)

Removes widget from cache.

Parameters:

widget - to be removed from cache

Returns:

true if widget has been removed, false otherwise

getImageForJasperWidgetPreferences

AImage getImageForJasperWidgetPreferences(JasperWidgetPreferencesModel widget)
                                   throws JasperWidgetException

Returns cached image for widget. If no image is in the cache, the implementing class must create one, add it to the cache and return it.

Parameters:

widget - for which image is cached

Throws:

JasperWidgetException - when problem with export report to image occurred

update

boolean update(JasperWidgetPreferencesModel widget)

Updates cached report for specific widget.

Parameters:

widget - to be updated

invalidateAll

void invalidateAll()

Clears cache

getCompiledReport

JasperReport getCompiledReport(JasperWidgetPreferencesModel widget)

Returns cached report. If no report is in the cache, the implementing class must create one, add it to the cache and return it.

Parameters:

widget - for which report is cached.