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

Packages that use IReportDocument
Package
Description
org.eclipse.birt.report.engine.api
This is an application-writer's interface for using the BIRT report engine.

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

Methods in org.eclipse.birt.report.engine.api that return IReportDocument
Modifier and Type
Method
Description
`IReportDocument`
IReportDocumentInfo.`openReportDocument()`
Open a report document.
`IReportDocument`
IReportEngine.`openReportDocument(String fileName)`
Opens a report document and returns an IReportDocument object, from which further information can be retrieved.
`IReportDocument`
IReportEngine.`openReportDocument(String systemId, String fileName)`
Opens a report document and returns an IReportDocument object, from which further information can be retrieved.
`IReportDocument`
IReportEngine.`openReportDocument(String systemId, String fileName, Map options)`
Opens a report document and returns an IReportDocument object, from which further information can be retrieved.
`IReportDocument`
IReportEngine.`openReportDocument(String systemId, String fileName, org.eclipse.birt.report.model.api.IResourceLocator locator)`
Opens a report document and returns an IReportDocument object, from which further information can be retrieved.
`IReportDocument`
IReportEngine.`openReportDocument(String systemId, org.eclipse.birt.core.archive.IDocArchiveReader archiveReader, Map options)`
Opens a report document and returns an IReportDocument object, from which further information can be retrieved.
`IReportDocument`
IReportEngine.`openReportDocument(String fileName, org.eclipse.birt.report.model.api.IResourceLocator locator)`
Opens a report document and returns an IReportDocument object, from which further information can be retrieved.
`IReportDocument`
ReportEngine.`openReportDocument(String fileName)`
opens a report document and returns an IReportDocument object, from which further information can be retrieved.
`IReportDocument`
ReportEngine.`openReportDocument(String systemId, String fileName)`
opens a report document and returns an IReportDocument object, from which further information can be retrieved.
`IReportDocument`
ReportEngine.`openReportDocument(String systemId, String fileName, Map options)`
opens a report document and returns an IReportDocument object, from which further information can be retrieved.
`IReportDocument`
ReportEngine.`openReportDocument(String systemId, String fileName, org.eclipse.birt.report.model.api.IResourceLocator locator)`
opens a report document and returns an IReportDocument object, from which further information can be retrieved.
`IReportDocument`
ReportEngine.`openReportDocument(String systemId, org.eclipse.birt.core.archive.IDocArchiveReader reader, Map options)`
opens a report document and returns an IReportDocument object, from which further information can be retrieved.
`IReportDocument`
ReportEngine.`openReportDocument(String fileName, org.eclipse.birt.report.model.api.IResourceLocator locator)`
opens a report document and returns an IReportDocument object, from which further information can be retrieved.
Methods in org.eclipse.birt.report.engine.api with parameters of type IReportDocument
Modifier and Type
Method
Description
`IDataExtractionTask`
IReportEngine.`createDataExtractionTask(IReportDocument reportDocument)`
Creates a task that allows data extraction from a report document.
`IDataExtractionTask`
ReportEngine.`createDataExtractionTask(IReportDocument reportDocument)`
creates a task that allows data extraction from a report document
`IRenderTask`
IReportEngine.`createRenderTask(IReportDocument reportDocument)`
Creates a task that renders the report to a specific output format.
`IRenderTask`
IReportEngine.`createRenderTask(IReportDocument reportDocument, IReportRunnable reportRunnable)`
Create a task that renders the report to a specific output format.
`IRenderTask`
ReportEngine.`createRenderTask(IReportDocument reportDocument)`
creates 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.
`static Collection<IBookmarkInfo>`
DocumentUtil.`getBookmarks(IReportDocument document, Locale locale)`
`static boolean`
DocumentUtil.`isCube(IReportDocument document, InstanceID instanceId)`
Judge whether it's a cube based on instance id