|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRunTask
An engine task that runs a report and generates a report document.
Field Summary |
---|
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 |
enableProgressiveViewing(boolean enable)
need the run task support progressive viewing. |
void |
run(org.eclipse.birt.core.archive.FolderArchive fArchive)
Deprecated. |
void |
run(org.eclipse.birt.core.archive.IDocArchiveWriter archive)
|
void |
run(java.lang.String reportDocName)
runs the task to generate report document |
void |
setMaxRowsPerQuery(int maxRows)
set the max rows per query |
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, setDataSource, setErrorHandlingOption, setLocale, setLocale, setLogger, setParameter, setParameterDisplayText, setParameterValue, setParameterValues, setTimeZone, setUserACL, validateParameters |
Method Detail |
---|
void setPageHandler(IPageHandler callback)
callback
- a callback function that is called after each checkpointvoid run(java.lang.String reportDocName) throws EngineException
reportDocName
- the name for the report document file
EngineException
- throws exception when running report failsvoid run(org.eclipse.birt.core.archive.IDocArchiveWriter archive) throws EngineException
archive
- a document archive object that supports various doc-related functionalities
EngineException
- throws exception when running report failsvoid run(org.eclipse.birt.core.archive.FolderArchive fArchive) throws EngineException
fArchive
- a folder archive that is used both as the data source, and as output
The engine WILL overwrite the archive that is passed in!
EngineException
- throws exception when running report failsvoid setMaxRowsPerQuery(int maxRows)
maxRows:
- max rowsvoid enableProgressiveViewing(boolean enable)
enable
- true the render task can render the document while the run
task is generating.
false the render task must wait for the run task.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |