BBJasperReport

java.lang.Object
- BBJasper.BBJasperReport

```
public class BBJasperReport
extends Object
```
Creates a JasperReport to view, print, or save to file in various formats.
To determine which Jaspersoft Studio version is supported in BBj, check the version number that is included in the name of the {bbj install dir}/lib/jasperreports-javaflow-*.jar. For example, jasperreports-javaflow-6.1.0.jar means that this installed version of BBj is compatible with the 6.1.0 version of Jaspersoft Studio.

Since:

9.0

See Also:

Example

Field Summary

Fields
Modifier and Type	Field and Description
`static BBjNumber`	`CLIENT_OBJECT_ERROR` Constant value that represents a client object error
`static BBjNumber`	`CONNECTION_ERROR` Constant value that represents a connection error
`static BBjNumber`	`FILL_CANCELED` Constant value that represents that the fill operation was canceled
`static BBjNumber`	`FILL_ERROR` Constant value that represents a fill error
`static BBjNumber`	`REPORT_ERROR` Constant value that represents a error return code
`static BBjNumber`	`SUCCESS` Constant value that represents a successful return code
`static BBjNumber`	`VIRTUALIZATION_THRESHOLD_SIZE` Specifies the number of pages of the filled report created in memory before virutalization will begin.

Constructor Summary

Constructors
Constructor and Description
`BBJasperReport(BBjString p_reportFile$, BBjString p_connectString$)` Constructs a BBJasperReport given a report file and connect string
`BBJasperReport(BBjString p_reportFile$, BBjString p_connectString$, HashMap p_params!)` Constructs a BBJasperReport given a report file, connect string, and report parameters
`BBJasperReport(BBjString p_reportFile$, BBjString p_connectString$, HashMap p_params!, BBjString p_locale$)` Constructs a BBJasperReport given a report file, connect string, report parameters, and locale
`BBJasperReport(BBjString p_reportFile$, Collection p_collection!)` Constructs a BBJasperReport given a report file, result set, and report parameters
`BBJasperReport(BBjString p_reportFile$, Collection p_collection!, HashMap p_params!)` Constructs a BBJasperReport given a report file, result set, and report parameters
`BBJasperReport(BBjString p_reportFile$, Collection p_collection!, HashMap p_params!, BBjString p_locale$)` Constructs a BBJasperReport given a report file, result set, report parameters, and locale
`BBJasperReport(BBjString p_reportFile$, JRDataSource p_jrdatasource!)` Constructs a BBJasperReport given a report file, JRDataSource, and report parameters
`BBJasperReport(BBjString p_reportFile$, JRDataSource p_jrdatasource!, HashMap p_params!)` Constructs a BBJasperReport given a report file, JRDataSource, and report parameters
`BBJasperReport(BBjString p_reportFile$, JRDataSource p_jrdatasource!, HashMap p_params!, BBjString p_locale$)` Constructs a BBJasperReport given a report file, JRDataSource, report parameters, and locale
`BBJasperReport(BBjString p_reportFile$, ResultSet p_rs!)` Constructs a BBJasperReport given a report file and result set
`BBJasperReport(BBjString p_reportFile$, ResultSet p_rs!, HashMap p_params!)` Constructs a BBJasperReport given a report file, result set, and report parameters
`BBJasperReport(BBjString p_reportFile$, ResultSet p_rs!, HashMap p_params!, BBjString p_locale$)` Constructs a BBJasperReport given a report file, result set, report parameters, and locale

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendReport(BBJasperReport p_report!)` Appends the passed BBJasperReport to the current report
`void`	`cleanupVirtualization()` Removes temporary files that are created when virtualization is used.
`BBJasperReport`	`clone()` Creates and returns a copy of the current BBJasperReport object
`BBJasperReport`	`createSubReport(BBjString p_reportFile$, HashMap p_params!)` Creates a sub report, which inherits parameters from this report
`void`	`destroy()` Destroys the BBJasperReport object
`void`	`email(Email p_email!)` Emails the report as an attachment
`void`	`exportToCSV(BBjNumber p_onClient, BBjString p_filepath$)` Exports the report in CSV file format
`void`	`exportToCSV(BBjNumber p_onClient, BBjString p_filepath$, BBJasperCSVExporter p_bbjasperCSVExporter!)` Exports the report in CSV file format
`void`	`exportToDOCX(BBjNumber p_onClient, BBjString p_filepath$)` Exports the report in DOCX file format
`void`	`exportToDOCX(BBjNumber p_onClient, BBjString p_filepath$, BBJasperDOCXExporter p_bbjasperDOCXExporter!)` Exports the report in DOCX file format
`void`	`exportToHTML(BBjNumber p_onClient, BBjString p_filepath$)` Exports the report in HTML file format
`void`	`exportToHTML(BBjNumber p_onClient, BBjString p_filepath$, BBJasperHTMLExporter p_bbjasperHTMLExporter!)` Exports the report in HTML file format
`void`	`exportToJRPRINT(BBjNumber p_onClient, BBjString p_filepath$)` Exports the report in JRPRNT file format
`void`	`exportToODS(BBjNumber p_onClient, BBjString p_filepath$)` Exports the report in ODS file format
`void`	`exportToODS(BBjNumber p_onClient, BBjString p_filepath$, BBJasperODSExporter p_bbjasperODSExporter!)` Exports the report in ODS file format
`void`	`exportToODT(BBjNumber p_onClient, BBjString p_filepath$)` Exports the report in ODT file format
`void`	`exportToODT(BBjNumber p_onClient, BBjString p_filepath$, BBJasperODTExporter p_bbjasperODTExporter!)` Exports the report in ODT file format
`void`	`exportToPDF(BBjNumber p_onClient, BBjString p_filepath$)` Exports the report in PDF file format
`void`	`exportToPDF(BBjNumber p_onClient, BBjString p_filepath$, BBJasperPDFExporter p_bbjasperPDFExporter!)` Exports the report in PDF file format
`void`	`exportToPPTX(BBjNumber p_onClient, BBjString p_filepath$)` Exports the report in PPTX file format
`void`	`exportToPPTX(BBjNumber p_onClient, BBjString p_filepath$, BBJasperPPTXExporter p_bbjasperPPTXExporter!)` Exports the report in PPTX file format
`void`	`exportToRTF(BBjNumber p_onClient, BBjString p_filepath$)` Exports the report in RTF file format
`void`	`exportToRTF(BBjNumber p_onClient, BBjString p_filepath$, BBJasperRTFExporter p_bbjasperRTFExporter!)` Exports the report in RTF file format
`void`	`exportToTXT(BBjNumber p_onClient, BBjString p_filepath$, BBjNumber p_pageWidth, BBjNumber p_pageHeight, BBjNumber p_charWidth, BBjNumber p_charHeight)` Exports the report in TXT file format
`void`	`exportToTXT(BBjNumber p_onClient, BBjString p_filepath$, BBjNumber p_pageWidth, BBjNumber p_pageHeight, BBjNumber p_charWidth, BBjNumber p_charHeight, BBJasperTXTExporter p_bbjasperTXTExporter!)` Exports the report in TXT file format
`void`	`exportToXLS(BBjNumber p_onClient, BBjString p_filepath$)` Exports the report in XLS file format
`void`	`exportToXLS(BBjNumber p_onClient, BBjString p_filepath$, BBJasperXLSExporter p_bbjasperXLSExporter!)` Exports the report in XLS file format
`void`	`exportToXLS(BBjNumber p_onClient, BBjString p_filepath$, BBjNumber p_multipleSheets)` Exports the report in XLS file format
`void`	`exportToXLS(BBjNumber p_onClient, BBjString p_filepath$, BBjNumber p_multipleSheets, BBJasperXLSExporter p_bbjasperXLSExporter!)` Exports the report in XLS file format
`void`	`exportToXLSX(BBjNumber p_onClient, BBjString p_filepath$)` Exports the report in XLSX file format
`void`	`exportToXLSX(BBjNumber p_onClient, BBjString p_filepath$, BBJasperXLSXExporter p_bbjasperXLSXExporter!)` Exports the report in XLSX file format
`void`	`exportToXML(BBjNumber p_onClient, BBjString p_filepath$, BBjNumber p_isEmbeddingImages)` Exports the report in XML file format
`void`	`exportToXML(BBjNumber p_onClient, BBjString p_filepath$, BBjNumber p_isEmbeddingImages, BBJasperXMLExporter p_bbjasperXMLExporter!)` Exports the report in XML file format
`BBjNumber`	`fill()` Fills the report with data
`BBjNumber`	`fill(BBjNumber p_showProgress)` Fills the report with data
`JasperPrint@`	`getClientJasperPrint()` Creates (if necessary) and returns the client JasperPrint object
`BBjString`	`getConnectString()` Returns the JDBC connect string
`BBjString`	`getDefaultFilePrefix()` returns the default file prefix for temporary files like email attachements
`JasperPrint`	`getJasperPrint()` Returns the JasperPrint object
`JasperReport`	`getJasperReport()` Returns the JasperReport object
`Object`	`getParam(BBjString p_key$)` Returns an individual parameter
`HashMap`	`getParams()` Returns all report parameters
`BBjString`	`getReportDir()` Returns the report directory
`BBjString`	`getReportFile()` Returns the report file
`BBjNumber`	`print(BBjNumber p_onClient, BBjNumber p_dialog)` Prints the report
`BBjNumber`	`print(BBjNumber p_onClient, BBjNumber p_dialog, BBJasperPrintServiceExporter p_bbjasperPrintServiceExporter!)` Prints the report
`void`	`putParam(BBjString p_key$, Object p_value!)` Sets an individual report parameter
`void`	`putParams(HashMap p_hashMap!)` Sets report parameters
`static Class`	`registerJDBCDriver(BBjString p_jdbcDriverClass$)` Registers the passed JDBC driver class
`void`	`removeParam(BBjString p_key$)` Removes an individual report parameter
`void`	`removeParams()` Removes all report parameters
`void`	`setJasperReport(JasperReport p_report!)` Sets the working JasperReport object
`void`	`setLocale(BBjString p_localeString$)` Sets the report locale parameter given a string
`void`	`setLocale(Locale p_locale!)` Sets the report locale parameter given a Java Locale object
`void`	`setMaxPages(BBjNumber p_maxPages)` Sets the max number of report pages
`void`	`setupVirtualization()` Sets virtualization on.
`void`	`setupVirtualization(BBjNumber p_thresholdSize)` Sets when virtualization will occur.
`void`	`setupVirtualization(BBjNumber p_thresholdSize, BBjString p_virtualizationDirectory$)` Sets when virtualization will occur and where the temporary files will be created.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SUCCESS
```
public static BBjNumber SUCCESS
```
    Constant value that represents a successful return code
  - REPORT_ERROR
```
public static BBjNumber REPORT_ERROR
```
    Constant value that represents a error return code
  - CONNECTION_ERROR
```
public static BBjNumber CONNECTION_ERROR
```
    Constant value that represents a connection error
  - FILL_ERROR
```
public static BBjNumber FILL_ERROR
```
    Constant value that represents a fill error
  - FILL_CANCELED
```
public static BBjNumber FILL_CANCELED
```
    Constant value that represents that the fill operation was canceled
  - CLIENT_OBJECT_ERROR
```
public static BBjNumber CLIENT_OBJECT_ERROR
```
    Constant value that represents a client object error
  - VIRTUALIZATION_THRESHOLD_SIZE
```
public static BBjNumber VIRTUALIZATION_THRESHOLD_SIZE
```
    Specifies the number of pages of the filled report created in memory before virutalization will begin.
- Constructor Detail
  - BBJasperReport
```
public BBJasperReport(BBjString p_reportFile$,
BBjString p_connectString$)
```
    Constructs a BBJasperReport given a report file and connect string
    
    Parameters:
    
    p_reportFile$ - Jrxml or jasper report file
    
    p_connectString$ - JDBC connect string
  - BBJasperReport
```
public BBJasperReport(BBjString p_reportFile$,
BBjString p_connectString$,
HashMap p_params!)
```
    Constructs a BBJasperReport given a report file, connect string, and report parameters
    
    Parameters:
    
    p_reportFile$ - Jrxml or jasper report file
    
    p_connectString$ - JDBC connect string
    
    p_params! - Report parameters
  - BBJasperReport
```
public BBJasperReport(BBjString p_reportFile$,
BBjString p_connectString$,
HashMap p_params!,
BBjString p_locale$)
```
    Constructs a BBJasperReport given a report file, connect string, report parameters, and locale
    
    Parameters:
    
    p_reportFile$ - Jrxml or jasper report file
    
    p_connectString$ - JDBC connect string
    
    p_params! - Report parameters
    
    p_locale$ - Locale
  - BBJasperReport
```
public BBJasperReport(BBjString p_reportFile$,
ResultSet p_rs!)
```
    Constructs a BBJasperReport given a report file and result set
    
    Parameters:
    
    p_reportFile$ - Jrxml or jasper report file
    
    p_rs! - Result set contaning the data for the report
    
    Since:
    
    13.0
  - BBJasperReport
```
public BBJasperReport(BBjString p_reportFile$,
ResultSet p_rs!,
HashMap p_params!)
```
    Constructs a BBJasperReport given a report file, result set, and report parameters
    
    Parameters:
    
    p_reportFile$ - Jrxml or jasper report file
    
    p_rs! - Result set contaning the data for the report
    
    p_params! - Report parameters
    
    Since:
    
    13.0
  - BBJasperReport
```
public BBJasperReport(BBjString p_reportFile$,
ResultSet p_rs!,
HashMap p_params!,
BBjString p_locale$)
```
    Constructs a BBJasperReport given a report file, result set, report parameters, and locale
    
    Parameters:
    
    p_reportFile$ - Jrxml or jasper report file
    
    p_rs! - Result set contaning the data for the report
    
    p_params! - Report parameters
    
    p_locale$ - Locale
    
    Since:
    
    13.0
  - BBJasperReport
```
public BBJasperReport(BBjString p_reportFile$,
Collection p_collection!)
```
    Constructs a BBJasperReport given a report file, result set, and report parameters
    
    Parameters:
    
    p_reportFile$ - Jrxml or jasper report file
    
    p_collection! - Collection contaning the data for the report
    
    Since:
    
    14.30
  - BBJasperReport
```
public BBJasperReport(BBjString p_reportFile$,
Collection p_collection!,
HashMap p_params!)
```
    Constructs a BBJasperReport given a report file, result set, and report parameters
    
    Parameters:
    
    p_reportFile$ - Jrxml or jasper report file
    
    p_collection! - Collection contaning the data for the report
    
    p_params! - Report parameters
    
    Since:
    
    14.30
  - BBJasperReport
```
public BBJasperReport(BBjString p_reportFile$,
Collection p_collection!,
HashMap p_params!,
BBjString p_locale$)
```
    Constructs a BBJasperReport given a report file, result set, report parameters, and locale
    
    Parameters:
    
    p_reportFile$ - Jrxml or jasper report file
    
    p_collection! - Collection contaning the data for the report
    
    p_params! - Report parameters
    
    p_locale$ - Locale
    
    Since:
    
    14.30
  - BBJasperReport
```
public BBJasperReport(BBjString p_reportFile$,
JRDataSource p_jrdatasource!)
```
    Constructs a BBJasperReport given a report file, JRDataSource, and report parameters
    
    Parameters:
    
    p_reportFile$ - Jrxml or jasper report file
    
    p_jrdatasource! - JRDataSource contaning the data for the report
    
    Since:
    
    16.00
  - BBJasperReport
```
public BBJasperReport(BBjString p_reportFile$,
JRDataSource p_jrdatasource!,
HashMap p_params!)
```
    Constructs a BBJasperReport given a report file, JRDataSource, and report parameters
    
    Parameters:
    
    p_reportFile$ - Jrxml or jasper report file
    
    p_jrdatasource! - JRDataSource contaning the data for the report
    
    p_params! - Report parameters
    
    Since:
    
    16.00
  - BBJasperReport
```
public BBJasperReport(BBjString p_reportFile$,
JRDataSource p_jrdatasource!,
HashMap p_params!,
BBjString p_locale$)
```
    Constructs a BBJasperReport given a report file, JRDataSource, report parameters, and locale
    
    Parameters:
    
    p_reportFile$ - Jrxml or jasper report file
    
    p_jrdatasource! - JRDataSource contaning the data for the report
    
    p_params! - Report parameters
    
    p_locale$ - Locale
    
    Since:
    
    16.00
- Method Detail
  - setupVirtualization
```
public void setupVirtualization()
```
    Sets virtualization on.
    Virtualization can be used to avoid an out of memory condition when filling a report with a very large amount of data. Virtualization will offload this data to temporary files. Using virutalization makes the generation of the report a bit slower but it will avoid out of memory conditions.
    The method cleanupVirtualization should be called when a report that uses virtualization is no longer needed. This will remove the temporary files that were created during the virtualization process. If the leanupVirtualization method is not called, these temporary files will be removed when BBjServices is stopped.
    The VIRTUALIZATION_THRESHOLD_SIZE, which by default is 300, specifies the number of pages of the filled report created in memory before virutalization will begin.
    The "bbjasper" directory under the directory that is specified by Java System property "java.io.tmpdir" will be used to store virtualized files.
    
    Since:
    
    19.00
  - setupVirtualization
```
public void setupVirtualization(BBjNumber p_thresholdSize)
```
    Sets when virtualization will occur.
    Virtualization can be used to avoid an out of memory condition when filling a report with a very large amount of data. Virtualization will offload this data to temporary files. Using virutalization makes the generation of the report a bit slower but it will avoid out of memory conditions.
    The method cleanupVirtualization should be called when a report that uses virtualization is no longer needed. This will remove the temporary files that were created during the virtualization process. If the leanupVirtualization method is not called, these temporary files will be removed when BBjServices is stopped.
    The "bbjasper" directory under the directory that is specified by Java System property "java.io.tmpdir" will be used to store virtualized files.
    
    Parameters:
    
    p_thresholdSize - Specifies the number of pages of the filled report created in memory before virutalization will begin. If this number is less than 0 no virtualization will occur.
    
    Since:
    
    19.00
  - setupVirtualization
```
public void setupVirtualization(BBjNumber p_thresholdSize,
BBjString p_virtualizationDirectory$)
```
    Sets when virtualization will occur and where the temporary files will be created.
    Virtualization can be used to avoid an out of memory condition when filling a report with a very large amount of data. Virtualization will offload this data to temporary files. Using virutalization makes the generation of the report a bit slower but it will avoid out of memory conditions.
    The method cleanupVirtualization should be called when a report that uses virtualization is no longer needed. This will remove the temporary files that were created during the virtualization process. If the leanupVirtualization method is not called, these temporary files will be removed when BBjServices is stopped.
    
    Parameters:
    
    p_thresholdSize - Specifies the number pages of the filled report created in memory before virutalization will begin. If this number is less than 0 no virtualization will occur.
    
    p_virtualizationDirectory$ - Specifies the local directory in which virtualized files will be stored. This directory and parent directories will be created if they do not exist.
    
    Since:
    
    19.00
  - cleanupVirtualization
```
public void cleanupVirtualization()
```
    Removes temporary files that are created when virtualization is used.
    
    Since:
    
    19.00
  - clone
```
public BBJasperReport clone()
```
    Creates and returns a copy of the current BBJasperReport object
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    The cloned BBJasperReport object
  - putParams
```
public void putParams(HashMap p_hashMap!)
```
    Sets report parameters
    
    Parameters:
    
    p_hashMap! - Report parameters
  - putParam
```
public void putParam(BBjString p_key$,
Object p_value!)
```
    Sets an individual report parameter
    
    Parameters:
    
    p_key$ - Report pareameter key
    
    p_value! - Report pareameter value
  - setLocale
```
public void setLocale(Locale p_locale!)
```
    Sets the report locale parameter given a Java Locale object
    
    Parameters:
    
    p_locale! - Specifies the Locale object to use for the report
    
    See Also:
    
    Locale
  - setLocale
```
public void setLocale(BBjString p_localeString$)
```
    Sets the report locale parameter given a string
    
    Parameters:
    
    p_localeString$ - Specifies the locale as a string
  - createSubReport
```
public BBJasperReport createSubReport(BBjString p_reportFile$,
HashMap p_params!)
```
    Creates a sub report, which inherits parameters from this report
    
    Parameters:
    
    p_reportFile$ - Specifies a jrxml or jasper report file
    
    p_params! - Hashmap that contains report parameters
    
    Returns:
    
    BBJasperReport object
  - getParam
```
public Object getParam(BBjString p_key$)
```
    Returns an individual parameter
    
    Parameters:
    
    p_key$ - Report parameter key
    
    Returns:
    
    Report parameter value
  - getParams
```
public HashMap getParams()
```
    Returns all report parameters
    
    Returns:
    
    Report parameters
  - getConnectString
```
public BBjString getConnectString()
```
    Returns the JDBC connect string
    
    Returns:
    
    JDBC connect string
  - removeParams
```
public void removeParams()
```
    Removes all report parameters
  - removeParam
```
public void removeParam(BBjString p_key$)
```
    Removes an individual report parameter
    
    Parameters:
    
    p_key$ - Key of report parameter to remove
  - getDefaultFilePrefix
```
public BBjString getDefaultFilePrefix()
```
    returns the default file prefix for temporary files like email attachements
    
    Returns:
    
    DefaultFilePrefix BASIS by default
  - getReportFile
```
public BBjString getReportFile()
```
    Returns the report file
    
    Returns:
    
    Report file
  - getReportDir
```
public BBjString getReportDir()
```
    Returns the report directory
    
    Returns:
    
    Report directory
  - getJasperReport
```
public JasperReport getJasperReport()
```
    Returns the JasperReport object
    
    Returns:
    
    JasperReport object
  - setJasperReport
```
public void setJasperReport(JasperReport p_report!)
```
    Sets the working JasperReport object
    
    Parameters:
    
    p_report! - A JasperReport object
  - getJasperPrint
```
public JasperPrint getJasperPrint()
```
    Returns the JasperPrint object
    
    Returns:
    
    JasperPrint object
  - getClientJasperPrint
```
public JasperPrint@ getClientJasperPrint()
```
    Creates (if necessary) and returns the client JasperPrint object
    
    Returns:
    
    Client JasperPrint object. The error CLIENT_OBJECT_ERROR can also be thrown.
  - fill
```
public BBjNumber fill()
```
    Fills the report with data
    
    Returns:
    
    SUCCESS, FILL_CANCELED. The error FILL_ERROR can also be thrown.
  - fill
```
public BBjNumber fill(BBjNumber p_showProgress)
```
    Fills the report with data
    
    Parameters:
    
    p_showProgress - Specify 1 to show a progress window, otherwise 0
    
    Returns:
    
    SUCCESS, FILL_CANCELED. The error FILL_ERROR can also be thrown.
  - email
```
public void email(Email p_email!)
```
    Emails the report as an attachment
    An error will be thrown if not successful.
    
    Parameters:
    
    p_email! - Email object that will be used to send the report via email
  - print
```
public BBjNumber print(BBjNumber p_onClient,
BBjNumber p_dialog)
```
    Prints the report
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    Show - progress, specify TRUE to show a print dialog, otherwise FALSE
    
    Returns:
    
    TRUE on success and FALSE on failure
  - print
```
public BBjNumber print(BBjNumber p_onClient,
BBjNumber p_dialog,
BBJasperPrintServiceExporter p_bbjasperPrintServiceExporter!)
```
    Prints the report
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    Show - progress, specify TRUE to show a print dialog, otherwise FALSE
    
    p_bbjasperPrintServiceExporter! - BBJasperPrintExporter object which specifies print options
    
    Returns:
    
    TRUE on success and FALSE on failure
    
    Since:
    
    13.0
  - exportToHTML
```
public void exportToHTML(BBjNumber p_onClient,
BBjString p_filepath$)
```
    Exports the report in HTML file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
  - exportToHTML
```
public void exportToHTML(BBjNumber p_onClient,
BBjString p_filepath$,
BBJasperHTMLExporter p_bbjasperHTMLExporter!)
```
    Exports the report in HTML file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    p_bbjasperHTMLExporter! - BBJasperHTMLExporter object which specifies PDF export options
    
    Since:
    
    13.0
  - exportToPDF
```
public void exportToPDF(BBjNumber p_onClient,
BBjString p_filepath$)
```
    Exports the report in PDF file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
  - exportToPDF
```
public void exportToPDF(BBjNumber p_onClient,
BBjString p_filepath$,
BBJasperPDFExporter p_bbjasperPDFExporter!)
```
    Exports the report in PDF file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    p_bbjasperPDFExporter! - BBJasperPDFExporter object which specifies PDF export options
    
    Since:
    
    13.0
  - exportToXML
```
public void exportToXML(BBjNumber p_onClient,
BBjString p_filepath$,
BBjNumber p_isEmbeddingImages)
```
    Exports the report in XML file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    p_isEmbeddingImages - Specify 1 to embed image or 0 otherwise
  - exportToXML
```
public void exportToXML(BBjNumber p_onClient,
BBjString p_filepath$,
BBjNumber p_isEmbeddingImages,
BBJasperXMLExporter p_bbjasperXMLExporter!)
```
    Exports the report in XML file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    p_isEmbeddingImages - Specify TRUE to embed image or FALSE otherwise
    
    p_bbjasperXMLExporter! - BBJasperXMLExporter object which specifies export options
    
    Since:
    
    13.0
  - exportToJRPRINT
```
public void exportToJRPRINT(BBjNumber p_onClient,
BBjString p_filepath$)
```
    Exports the report in JRPRNT file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
  - exportToXLS
```
public void exportToXLS(BBjNumber p_onClient,
BBjString p_filepath$)
```
    Exports the report in XLS file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
  - exportToXLS
```
public void exportToXLS(BBjNumber p_onClient,
BBjString p_filepath$,
BBjNumber p_multipleSheets)
```
    Exports the report in XLS file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    p_multipleSheets - Specify 1 for multiple sheets or 0 otherwise
  - exportToXLS
```
public void exportToXLS(BBjNumber p_onClient,
BBjString p_filepath$,
BBJasperXLSExporter p_bbjasperXLSExporter!)
```
    Exports the report in XLS file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    p_bbjasperXLSExporter! - BBJasperXLSExporter object which specifies XLS export options
    
    Since:
    
    13.0
  - exportToXLS
```
public void exportToXLS(BBjNumber p_onClient,
BBjString p_filepath$,
BBjNumber p_multipleSheets,
BBJasperXLSExporter p_bbjasperXLSExporter!)
```
    Exports the report in XLS file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    p_multipleSheets - Specify 1 for multiple sheets or 0 otherwise
    
    p_bbjasperXLSExporter! - BBJasperXLSExporter object which specifies export options
    
    Since:
    
    13.0
  - exportToXLSX
```
public void exportToXLSX(BBjNumber p_onClient,
BBjString p_filepath$)
```
    Exports the report in XLSX file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    Since:
    
    15.0
  - exportToXLSX
```
public void exportToXLSX(BBjNumber p_onClient,
BBjString p_filepath$,
BBJasperXLSXExporter p_bbjasperXLSXExporter!)
```
    Exports the report in XLSX file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    p_bbjasperXLSXExporter! - BBJasperXLSXExporter object which specifies export options
    
    Since:
    
    15.0
  - exportToCSV
```
public void exportToCSV(BBjNumber p_onClient,
BBjString p_filepath$)
```
    Exports the report in CSV file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
  - exportToCSV
```
public void exportToCSV(BBjNumber p_onClient,
BBjString p_filepath$,
BBJasperCSVExporter p_bbjasperCSVExporter!)
```
    Exports the report in CSV file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    p_bbjasperCSVExporter! - BBJasperCSVExporter which object contains CSV export options
    
    Since:
    
    13.0
  - exportToRTF
```
public void exportToRTF(BBjNumber p_onClient,
BBjString p_filepath$)
```
    Exports the report in RTF file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
  - exportToRTF
```
public void exportToRTF(BBjNumber p_onClient,
BBjString p_filepath$,
BBJasperRTFExporter p_bbjasperRTFExporter!)
```
    Exports the report in RTF file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    p_bbjasperRTFExporter! - BBJasperRTFxporter object which contains RTF export options
    
    Since:
    
    13.0
  - exportToDOCX
```
public void exportToDOCX(BBjNumber p_onClient,
BBjString p_filepath$)
```
    Exports the report in DOCX file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
  - exportToDOCX
```
public void exportToDOCX(BBjNumber p_onClient,
BBjString p_filepath$,
BBJasperDOCXExporter p_bbjasperDOCXExporter!)
```
    Exports the report in DOCX file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    p_bbjasperDOCXExporter! - BBJasperDOCXExporter object which contains DOCX export options
    
    Since:
    
    13.0
  - exportToODT
```
public void exportToODT(BBjNumber p_onClient,
BBjString p_filepath$)
```
    Exports the report in ODT file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
  - exportToODT
```
public void exportToODT(BBjNumber p_onClient,
BBjString p_filepath$,
BBJasperODTExporter p_bbjasperODTExporter!)
```
    Exports the report in ODT file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    p_bbjasperODTExporter! - BBJasperODTExporter object which contains ODT export options
    
    Since:
    
    13.0
  - exportToODS
```
public void exportToODS(BBjNumber p_onClient,
BBjString p_filepath$)
```
    Exports the report in ODS file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
  - exportToODS
```
public void exportToODS(BBjNumber p_onClient,
BBjString p_filepath$,
BBJasperODSExporter p_bbjasperODSExporter!)
```
    Exports the report in ODS file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    p_bbjasperODSExporter! - BBJasperODSExporter object which contains ODS export options
    
    Since:
    
    13.0
  - exportToPPTX
```
public void exportToPPTX(BBjNumber p_onClient,
BBjString p_filepath$)
```
    Exports the report in PPTX file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
  - exportToPPTX
```
public void exportToPPTX(BBjNumber p_onClient,
BBjString p_filepath$,
BBJasperPPTXExporter p_bbjasperPPTXExporter!)
```
    Exports the report in PPTX file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    p_bbjasperPPTXExporter! - BBJasperPPTXExporter object which contains PPTX export options
    
    Since:
    
    13.0
  - exportToTXT
```
public void exportToTXT(BBjNumber p_onClient,
BBjString p_filepath$,
BBjNumber p_pageWidth,
BBjNumber p_pageHeight,
BBjNumber p_charWidth,
BBjNumber p_charHeight)
```
    Exports the report in TXT file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    p_pageWidth - Page width
    
    p_pageHeight - Page height
    
    p_charWidth - Character width
    
    p_charHeight - Character height
  - exportToTXT
```
public void exportToTXT(BBjNumber p_onClient,
BBjString p_filepath$,
BBjNumber p_pageWidth,
BBjNumber p_pageHeight,
BBjNumber p_charWidth,
BBjNumber p_charHeight,
BBJasperTXTExporter p_bbjasperTXTExporter!)
```
    Exports the report in TXT file format
    
    Parameters:
    
    p_onClient - Specify TRUE for client or FALSE for the server
    
    p_filepath$ - Path to file to export to
    
    p_pageWidth - Page width
    
    p_pageHeight - Page height
    
    p_charWidth - Character width
    
    p_charHeight - Character height
    
    p_bbjasperTXTExporter! - BBJasperTXTExporter object which contains TXT export options
    
    Since:
    
    13.0
  - appendReport
```
public void appendReport(BBJasperReport p_report!)
```
    Appends the passed BBJasperReport to the current report
    
    Parameters:
    
    p_report! - BBJasperReport object to append
    
    Since:
    
    13.0
  - setMaxPages
```
public void setMaxPages(BBjNumber p_maxPages)
```
    Sets the max number of report pages
    
    Parameters:
    
    p_maxPages - Specifies the number of max pages
    
    Since:
    
    13.0
  - destroy
```
public void destroy()
```
    Destroys the BBJasperReport object
  - registerJDBCDriver
```
public static Class registerJDBCDriver(BBjString p_jdbcDriverClass$)
```
    Registers the passed JDBC driver class
    
    Parameters:
    
    p_jdbcDriverClass$ - Name of the JDBC driver class to register

Class BBJasperReport

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SUCCESS

REPORT_ERROR

CONNECTION_ERROR

FILL_ERROR

FILL_CANCELED

CLIENT_OBJECT_ERROR

VIRTUALIZATION_THRESHOLD_SIZE

Constructor Detail

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

Method Detail

setupVirtualization

setupVirtualization

setupVirtualization

cleanupVirtualization

clone

putParams

putParam

setLocale

setLocale

createSubReport

getParam

getParams

getConnectString

removeParams

removeParam

getDefaultFilePrefix

getReportFile

getReportDir

getJasperReport

setJasperReport

getJasperPrint

getClientJasperPrint

fill

fill

email

print

print

exportToHTML

exportToHTML

exportToPDF

exportToPDF

exportToXML

exportToXML

exportToJRPRINT

exportToXLS

exportToXLS

exportToXLS

exportToXLS

exportToXLSX

exportToXLSX

exportToCSV

exportToCSV

exportToRTF

exportToRTF

exportToDOCX

exportToDOCX

exportToODT

exportToODT

exportToODS

exportToODS

exportToPPTX

exportToPPTX

exportToTXT