# Uses of Class
org.eclipse.birt.report.engine.api.EngineException

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

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

Subclasses of EngineException in org.eclipse.birt.report.engine.api
Modifier and Type
Class
Description
`class`
`UnsupportedFormatException`
Methods in org.eclipse.birt.report.engine.api that throw EngineException
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)`
`IDatasetPreviewTask`
IReportEngine.`createDatasetPreviewTask()`
`IDatasetPreviewTask`
ReportEngine.`createDatasetPreviewTask()`
`IEngineTask`
IReportEngine.`createEngineTask(String taskName)`
create an engine task
`IEngineTask`
ReportEngine.`createEngineTask(String taskName)`
`void`
IGetParameterDefinitionTask.`evaluateDefaults()`
Deprecated.
use getDefaultParameterValues() directly.
`IExtractionResults`
IDatasetPreviewTask.`execute()`
execute the query and return the result set
`IExtractionResults`
IDataExtractionTask.`extract()`
Redeclare this method in order to return IExtractionResults.
`List<IBookmarkInfo>`
IReportDocumentHelper.`getBookmarkInfos(Locale locale)`
`static Collection<IBookmarkInfo>`
DocumentUtil.`getBookmarks(IReportDocument document, Locale locale)`
`void`
HTMLServerImageHandler.`getImage(OutputStream out, String imageDir, String imageID)`
get image
`List`
IDataExtractionTask.`getMetaData()`
Deprecated.
`long`
IRenderTask.`getPageCount()`
Gets count of the pages that is output.
`long`
IRenderTask.`getPageNumber(String bookmark)`
Given a bookmark in a report, find the (first) page that the bookmark appears in (for hyperlinks to a bookmark)
`List`
IDataExtractionTask.`getResultSetList()`
returns the metadata corresponding to the data stored in the report document, for the specific extraction level, i.e., report, daat set, report item, or report item instance levels.
`ITOCTree`
IRenderTask.`getTOCTree()`
Get the TOC tree
`long`
IRenderTask.`getTotalPage()`
`IDocumentWriter`
IReportEngine.`openDocumentWriter(org.eclipse.birt.core.archive.compound.IArchiveFile file)`
creates a document writer that can write this archive file
`IDocumentWriter`
ReportEngine.`openDocumentWriter(org.eclipse.birt.core.archive.compound.IArchiveFile file)`
creates a document writer that can write this archive file
`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.
`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.
`void`
IRenderTask.`render()`
render the whole report document or an output format
`void`
IRenderTask.`render(long pageNumber)`
Deprecated.
A page with speicfic page number can be rendered like this:
`setPageNumber( pageNumber );`
`render( );`
`void`
IRenderTask.`render(String pageRange)`
Deprecated.
A range of pages can be rendered like this:
`setPageRange( pageRange );`
`render( );`
`void`
IRenderTask.`render(InstanceID iid)`
Deprecated.
A page which contains the instance can be rendered like this:
`setInstanceID( instanceID );`
`render( );`
`void`
IRunAndRenderTask.`run()`
runs the task to generate report document or other output format
`void`
IRunTask.`run()`
run this task.
`void`
IRunTask.`run(String reportDocName)`
runs the task to generate report document
`void`
IRunTask.`run(org.eclipse.birt.core.archive.FolderArchive fArchive)`
Deprecated.
`void`
IRunTask.`run(org.eclipse.birt.core.archive.IDocArchiveWriter archive)`
`void`
IRenderTask.`setBookmark(String bookmark)`
Sets bookmark.
`void`
IRenderTask.`setInstanceID(String iid)`
Sets id of instance which is a string type.
`void`
IRenderTask.`setInstanceID(InstanceID iid)`
Sets id of instance.
`void`
IRenderTask.`setPageNumber(long pageNumber)`
Sets number of the page to be rendered.
`void`
IRenderTask.`setPageRange(String pageRange)`
Sets range of the pages to be rendered.
`void`
IRenderTask.`setReportlet(String bookmark)`
Sets reportlet by bookmark.
`void`
IDocumentWriter.`setRunnable(IReportRunnable runnable)`
set a report runnable which can be used to update a report document