com.inet.report.schedule
Class CacheAction

java.lang.Object
  com.inet.report.schedule.ScheduleAction
      com.inet.report.schedule.CacheAction

public class CacheAction
extends ScheduleAction

This action will leave the rendered reports in the cache of i-net Clear Reports. This may be interesting for you if you want to provide your reports on the server and not render them on every call by a user. If you use this CacheAction the reports will stay in the cache of i-net Clear Reports. If the task using this CacheAction is executed then the report in the cache will be updated. During the rendering the old instance of the report will be still available.
This action will only have effect if the cache is a hard disk cache or a database cache.
Please also set the properties "useClientLocale" to "false" and "reloadOnNewRequest" to "false" in your i-net Clear Reports configuration so that you will get the scheduled report when you query the report via the applet or the cache interface.

Since:

i-net Crystal-Clear 6.0

Field Summary

Fields inherited from class com.inet.report.schedule.ScheduleAction

TYPE_CACHE, TYPE_CUSTOM, TYPE_EMAIL, TYPE_FILE, TYPE_FTP, TYPE_PRINT

Constructor Summary

CacheAction()
Creates an instance of CacheAction.

Method Summary

void	action(ExecutedTask task) This will render the reports of the task so that they will be updated in the cache of i-net Clear Reports.
boolean	isRenderAllFormats() Returns whether all report formats should be saved into the cache.
void	setRenderAllFormats(boolean renderAllFormats) Sets whether all formats should be saved into the cache or if only the report property "export_fmt" should be used.
java.lang.String	toString() Returns a string representation of this CacheAction.

Methods inherited from class com.inet.report.schedule.ScheduleAction

getErrorMessages, getType, isValid

Constructor Detail

CacheAction

public CacheAction()

Creates an instance of CacheAction.

Method Detail

action

public void action(ExecutedTask task)

This will render the reports of the task so that they will be updated in the cache of i-net Clear Reports.
Note: This action will have an effect only if the cache type used is either hard disk cache or database cache.

Specified by:

action in class ScheduleAction

Parameters:

task - The task which has been executed including all reports which are associated with the task.

isRenderAllFormats

public boolean isRenderAllFormats()

Returns whether all report formats should be saved into the cache. If this returns true the report property "export_fmt" will be ignored for the cache actions and all available report formats will be rendered.

Returns:

True when all formats will be saved into the cache, false only the format given with the report property "export_fmt" will be saved into the cache.

See Also:

setRenderAllFormats(boolean)

setRenderAllFormats

public void setRenderAllFormats(boolean renderAllFormats)

Sets whether all formats should be saved into the cache or if only the report property "export_fmt" should be used.
Usually you should not set this property to "true" because in only a few cases all export formats of a report are needed.
The default value of this property is false.

Parameters:

renderAllFormats - Set to true if you want all formats and false if you want the format specified with the report property "export_fmt" should be saved into the cache.

See Also:

isRenderAllFormats()

toString

public java.lang.String toString()

Returns a string representation of this CacheAction. The string returned will contain the value of the property "renderAllFormats" and any error message of ScheduleAction.getErrorMessages() if available.

Overrides:

toString in class ScheduleAction

Returns:

A string representation of this CacheAction.

Since:

6.1