|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRunAndRenderTask
an engine task that runs a report and renders it to one of the output formats supported by the engine.
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 | |
---|---|
IRenderOption |
getRenderOption()
|
void |
run()
runs the task to generate report document or other output format |
void |
setEmitterID(java.lang.String id)
sets a specific emitter to use when generate output. |
void |
setMaxRowsPerQuery(int maxRows)
set the max rows per query |
void |
setPageHandler(IPageHandler callback)
set user defined IPageHandler |
void |
setRenderOption(IRenderOption options)
set the rendering options |
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 setRenderOption(IRenderOption options)
settings
- the rendering optionsIRenderOption getRenderOption()
void run() throws EngineException
EngineException
void setEmitterID(java.lang.String id)
id
- the identifier for the emittervoid setMaxRowsPerQuery(int maxRows)
maxRows:
- max rowsvoid setPageHandler(IPageHandler callback)
callback
- user-defined IPageHandler
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |