public interface IRunTask extends IEngineTask
CANCEL_ON_ERROR, CONTINUE_ON_ERROR, STATUS_CANCELLED, STATUS_FAILED, STATUS_NOT_STARTED, STATUS_RUNNING, STATUS_SUCCEEDED, TASK_DATAEXTRACTION, TASK_DATASETPREVIEW, TASK_GETPARAMETERDEFINITION, TASK_RENDER, TASK_RUN, TASK_RUNANDRENDER, TASK_UNKNOWN
Modifier and Type | Method and Description |
---|---|
void |
enableProgressiveViewing(boolean enable)
need the run task support progressive viewing.
|
void |
run()
run this task.
|
void |
run(FolderArchive fArchive)
Deprecated.
|
void |
run(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
|
void |
setReportDocument(IArchiveFile archive)
set report document.
|
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, setParameter, setParameterDisplayText, setParameterDisplayText, setParameterValue, setParameterValue, setParameterValues, setProgressMonitor, setStatusHandler, setTimeZone, setUserACL, validateParameters
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 fileEngineException
- throws exception when running report failsvoid run(IDocArchiveWriter archive) throws EngineException
archive
- a document archive object that supports various doc-related functionalitiesEngineException
- throws exception when running report failsvoid run(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.void setReportDocument(IArchiveFile archive)
archive
- the archive filevoid run() throws EngineException
EngineException
Copyright © 2014 OpenText Corp. All rights reserved.