org.eclipse.birt.report.engine.api
Interface IRunTask
- All Superinterfaces:
- IEngineTask
- public interface IRunTask
- extends IEngineTask
An engine task that runs a report and generates a report document.
Fields inherited from interface org.eclipse.birt.report.engine.api.IEngineTask |
CANCEL_ON_ERROR, CONTINUE_ON_ERROR, STATUS_CANCELLED, STATUS_FAILED, STATUS_NOT_STARTED, STATUS_RUNNING, STATUS_SUCCEEDED, TASK_DATAEXTRACTION, TASK_GETPARAMETERDEFINITION, TASK_RENDER, TASK_RUN, TASK_RUNANDRENDER, TASK_UNKNOWN |
Method Summary |
void |
run(java.lang.String reportDocName)
runs the task to generate report document |
void |
setPageHandler(IPageHandler callback)
set up event handler to be called after each page is generated |
Methods inherited from interface org.eclipse.birt.report.engine.api.IEngineTask |
addScriptableJavaObject, cancel, cancel, close, getAppContext, getCancelFlag, getEngine, getErrors, getID, getLocale, getLogger, getParameterDisplayText, getParameterValue, getParameterValues, getReportRunnable, getStatus, getTaskType, getULocale, setAppContext, setDataSource, setErrorHandlingOption, setLocale, setLocale, setLogger, setParameter, setParameterDisplayText, setParameterValue, setParameterValues, validateParameters |
setPageHandler
public void setPageHandler(IPageHandler callback)
- set up event handler to be called after each page is generated
- Parameters:
callback
- a callback function that is called after each checkpoint
run
public void run(java.lang.String reportDocName)
throws EngineException
- runs the task to generate report document
- Parameters:
reportDocName
- the name for the report document file
- Throws:
EngineException
- throws exception when running report fails
Copyright © 2005 Actuate Corp. All rights reserved.