Interface IRunTask

All Superinterfaces:
IEngineTask

public interface IRunTask extends IEngineTask
An engine task that runs a report and generates a report document.
  • Method Details

    • setPageHandler

      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

      void run(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

      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

      @Deprecated 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
    • setMaxRowsPerQuery

      void setMaxRowsPerQuery(int maxRows)
      set the max rows per query
      Parameters:
      maxRows - : max rows
    • enableProgressiveViewing

      void enableProgressiveViewing(boolean enable)
      need the run task support progressive viewing. the default value is TRUE.
      Parameters:
      enable - true the render task can render the document while the run task is generating. false the render task must wait for the run task.
    • setReportDocument

      void setReportDocument(org.eclipse.birt.core.archive.compound.IArchiveFile archive)
      set report document. This archive takes precedence over a report document name
      Parameters:
      archive - the archive file
    • setReportDocument

      void setReportDocument(String name)
      set report document name
      Parameters:
      name - report document name
    • run

      void run() throws EngineException
      run this task.
      Throws:
      EngineException