# Uses of Interface
org.eclipse.birt.report.engine.api.IReportRunnable

Packages that use IReportRunnable
Package
Description
org.eclipse.birt.report.engine.api
This is an application-writer's interface for using the BIRT report engine.
org.eclipse.birt.report.engine.emitter
Defines the interfaces of report emitters, and also provides serval general classes for emitters to output XML document, process hyperline, etc.

## Uses of IReportRunnable in org.eclipse.birt.report.engine.api

Methods in org.eclipse.birt.report.engine.api that return IReportRunnable
Modifier and Type
Method
Description
`IReportRunnable`
IReportDocument.`getDocumentRunnable()`
The report runnable is used to create the report document while writing.
`IReportRunnable`
IReportDocument.`getPreparedRunnable()`
The report runnable is used to create the report document while writing.
`IReportRunnable`
IEngineTask.`getReportRunnable()`
returns the runnable report design object
`IReportRunnable`
IReportDocument.`getReportRunnable()`
The report runnable is used to create the report document while writing.
`IReportRunnable`
IReportPart.`getReportRunnable()`
returns the runnable report design
`IReportRunnable`
IReportEngine.`openReportDesign(InputStream designStream)`
Opens a report design stream and creates a report design runnable.
`IReportRunnable`
IReportEngine.`openReportDesign(String designName)`
Opens a report design file and creates a report design runnable.
`IReportRunnable`
IReportEngine.`openReportDesign(String name, InputStream designStream)`
Opens a report design stream and creates a report design runnable.
`IReportRunnable`
IReportEngine.`openReportDesign(String name, InputStream designStream, Map options)`
Open the report design and return the runnable.
`IReportRunnable`
IReportEngine.`openReportDesign(String name, InputStream designStream, org.eclipse.birt.report.model.api.IResourceLocator locator)`
Opens a report design stream and creates a report design runnable.
`IReportRunnable`
IReportEngine.`openReportDesign(String designName, org.eclipse.birt.report.model.api.IResourceLocator locator)`
Opens a report design file and creates a report design runnable.
`IReportRunnable`
IReportEngine.`openReportDesign(org.eclipse.birt.report.model.api.ReportDesignHandle designHandle)`
Opens a report designHandle and creates a report design runnable.
`IReportRunnable`
ReportEngine.`openReportDesign(InputStream designStream)`
opens a report design stream and creates a report design runnable.
`IReportRunnable`
ReportEngine.`openReportDesign(String designName)`
opens a report design file and creates a report design runnable.
`IReportRunnable`
ReportEngine.`openReportDesign(String name, InputStream designStream)`
opens a report design stream and creates a report design runnable.
`IReportRunnable`
ReportEngine.`openReportDesign(String name, InputStream designStream, Map options)`
open the report design and return the runnable
`IReportRunnable`
ReportEngine.`openReportDesign(String name, InputStream designStream, org.eclipse.birt.report.model.api.IResourceLocator locator)`
opens a report design stream and creates a report design runnable.
`IReportRunnable`
ReportEngine.`openReportDesign(String designName, org.eclipse.birt.report.model.api.IResourceLocator locator)`
opens a report design file and creates a report design runnable.
`IReportRunnable`
ReportEngine.`openReportDesign(org.eclipse.birt.report.model.api.ReportDesignHandle designHandle)`
opens a report designHandle and creates a report design runnable.
Methods in org.eclipse.birt.report.engine.api with parameters of type IReportRunnable
Modifier and Type
Method
Description
`static void`
DocumentUtil.`copy(org.eclipse.birt.core.archive.compound.IArchiveFile source, org.eclipse.birt.core.archive.compound.IArchiveFile target, IReportRunnable runnable)`
`static void`
DocumentUtil.`copy(org.eclipse.birt.core.archive.compound.IArchiveFile source, org.eclipse.birt.core.archive.compound.IArchiveFile target, IReportRunnable runnable, Map<String,String> transformations)`
`IGetParameterDefinitionTask`
IReportEngine.`createGetParameterDefinitionTask(IReportRunnable reportRunnable)`
Creates an engine task for obtaining report parameter definitions.
`IGetParameterDefinitionTask`
ReportEngine.`createGetParameterDefinitionTask(IReportRunnable reportRunnable)`
creates an engine task for obtaining report parameter definitions
`IRenderTask`
IReportEngine.`createRenderTask(IReportDocument reportDocument, IReportRunnable reportRunnable)`
Create a task that renders the report to a specific output format.
`IRenderTask`
ReportEngine.`createRenderTask(IReportDocument reportDocument, IReportRunnable reportRunnable)`
create a task that renders the report to a specific output format.
`IRunAndRenderTask`
IReportEngine.`createRunAndRenderTask(IReportRunnable reportRunnable)`
Creates an engine task for running and rendering report directly to output format.
`IRunAndRenderTask`
ReportEngine.`createRunAndRenderTask(IReportRunnable reportRunnable)`
creates an engine task for running and rendering report directly to output format
`IRunTask`
IReportEngine.`createRunTask(IReportRunnable reportRunnable)`
Creates a task to run a report to generate a report document.
`IRunTask`
ReportEngine.`createRunTask(IReportRunnable reportRunnable)`
creates a task to run a report to generate a report document
`void`
IDocumentWriter.`setRunnable(IReportRunnable runnable)`
set a report runnable which can be used to update a report document

## Uses of IReportRunnable in org.eclipse.birt.report.engine.emitter

Methods in org.eclipse.birt.report.engine.emitter that return IReportRunnable
Modifier and Type
Method
Description
`IReportRunnable`
IEmitterServices.`getReportRunnable()`