Class DefaultJasperReportsRefreshService
- java.lang.Object
-
- de.hybris.platform.cockpit.reports.impl.DefaultJasperReportsRefreshService
-
- All Implemented Interfaces:
JasperReportsRefreshService
public class DefaultJasperReportsRefreshService extends java.lang.Object implements JasperReportsRefreshService
Default implementation ofJasperReportsRefreshService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
DefaultJasperReportsRefreshService.RefreshUnit
-
Constructor Summary
Constructors Constructor Description DefaultJasperReportsRefreshService()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
onRefresh()
Refresh all available reports.void
setJasperReportsCacheService(JasperReportCacheService jasperReportsCacheService)
void
startRefreshing(WidgetPreferencesModel widget, RefreshTimeOption refreshOption)
Start automatic refresh of the widget.void
stopRefreshing(WidgetPreferencesModel widget)
Stop automatic refreshing of the widget
-
-
-
Method Detail
-
startRefreshing
public void startRefreshing(WidgetPreferencesModel widget, RefreshTimeOption refreshOption)
Description copied from interface:JasperReportsRefreshService
Start automatic refresh of the widget. This method should be called each time the refresh requirements have changed and when a widget is loaded in the system. Initially, the method does not have to be called, because default refresh rate is set to NEVER. Two consecutive calls are allowed.- Specified by:
startRefreshing
in interfaceJasperReportsRefreshService
-
stopRefreshing
public void stopRefreshing(WidgetPreferencesModel widget)
Description copied from interface:JasperReportsRefreshService
Stop automatic refreshing of the widget- Specified by:
stopRefreshing
in interfaceJasperReportsRefreshService
-
onRefresh
public boolean onRefresh()
Description copied from interface:JasperReportsRefreshService
Refresh all available reports. Returns true if page update is required- Specified by:
onRefresh
in interfaceJasperReportsRefreshService
-
setJasperReportsCacheService
public void setJasperReportsCacheService(JasperReportCacheService jasperReportsCacheService)
- Parameters:
jasperReportsCacheService
- the jasperReportsCacheService to set
-
-