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.

Method Summary

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	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, getEngine, getErrors, getID, getLocale, getParameterValue, getParameterValues, getReportRunnable, getULocale, setAppContext, setDataSource, setLocale, setLocale, setParameterValue, setParameterValues, validateParameters

Method Detail

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

run

public void run(org.eclipse.birt.core.archive.IDocArchiveWriter archive)
         throws EngineException

Parameters:

archive - a document archive object that supports various doc-related functionalities

Throws:

EngineException - throws exception when running report fails

run

public void run(org.eclipse.birt.core.archive.FolderArchive fArchive)
         throws EngineException

Deprecated.

Parameters:

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!

Throws:

EngineException - throws exception when running report fails