BBJasperReport

```
public class BBJasperReport
```
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.

See Also:
[ Example]
Since:
9.0

Field Summary

Fields
Modifier and Type	Field and Description
`static BBjNumber`	`CLIENT_OBJECT_ERROR=306` Constant value that represents a client object error
`static BBjNumber`	`CONNECTION_ERROR=302` Constant value that represents a connection error
`static BBjNumber`	`FILL_CANCELED=305` Constant value that represents that the fill operation was canceled
`static BBjNumber`	`FILL_ERROR=304` Constant value that represents a fill error
`static BBjNumber`	`REPORT_ERROR=301` Constant value that represents a error return code
`static BBjNumber`	`SUCCESS=0` Constant value that represents a successful return code
`static BBjNumber`	`VIRTUALIZATION_THRESHOLD_SIZE=300` 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$)` Constructor Constructs a BBJasperReport given a report file and connect string
`BBJasperReport(BBjString p_reportFile$, ResultSet p_rs!)` Constructor Constructs a BBJasperReport given a report file and result set
`BBJasperReport(BBjString p_reportFile$, Collection p_collection!)` Constructor Constructs a BBJasperReport given a report file, result set, and report parameters
`BBJasperReport(BBjString p_reportFile$, JRDataSource p_jrdatasource!)` Constructor Constructs a BBJasperReport given a report file, JRDataSource, and report parameters
`BBJasperReport(BBjString p_reportFile$, BBjString p_connectString$, HashMap p_params!)` Constructor Constructs a BBJasperReport given a report file, connect string, and report parameters
`BBJasperReport(BBjString p_reportFile$, ResultSet p_rs!, HashMap p_params!)` Constructor Constructs a BBJasperReport given a report file, result set, and report parameters
`BBJasperReport(BBjString p_reportFile$, Collection p_collection!, HashMap p_params!)` Constructor Constructs a BBJasperReport given a report file, result set, and report parameters
`BBJasperReport(BBjString p_reportFile$, JRDataSource p_jrdatasource!, HashMap p_params!)` Constructor Constructs a BBJasperReport given a report file, JRDataSource, and report parameters
`BBJasperReport(BBjString p_reportFile$, BBjString p_connectString$, HashMap p_params!, BBjString p_locale$)` Constructor Constructs a BBJasperReport given a report file, connect string, report parameters, and locale
`BBJasperReport(BBjString p_reportFile$, ResultSet p_rs!, HashMap p_params!, BBjString p_locale$)` Constructor Constructs a BBJasperReport given a report file, result set, report parameters, and locale
`BBJasperReport(BBjString p_reportFile$, Collection p_collection!, HashMap p_params!, BBjString p_locale$)` Constructor Constructs a BBJasperReport given a report file, result set, report parameters, and locale
`BBJasperReport(BBjString p_reportFile$, JRDataSource p_jrdatasource!, HashMap p_params!, BBjString p_locale$)` Constructor Constructs a BBJasperReport given a report file, JRDataSource, report parameters, and locale

Method Summary

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

Field Detail
- CLIENT_OBJECT_ERROR=306
```
public static BBjNumber CLIENT_OBJECT_ERROR=306
```
  Constant value that represents a client object error
- CONNECTION_ERROR=302
```
public static BBjNumber CONNECTION_ERROR=302
```
  Constant value that represents a connection error
- FILL_CANCELED=305
```
public static BBjNumber FILL_CANCELED=305
```
  Constant value that represents that the fill operation was canceled
- FILL_ERROR=304
```
public static BBjNumber FILL_ERROR=304
```
  Constant value that represents a fill error
- REPORT_ERROR=301
```
public static BBjNumber REPORT_ERROR=301
```
  Constant value that represents a error return code
- SUCCESS=0
```
public static BBjNumber SUCCESS=0
```
  Constant value that represents a successful return code
- VIRTUALIZATION_THRESHOLD_SIZE=300
```
public static BBjNumber VIRTUALIZATION_THRESHOLD_SIZE=300
```
  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$)
```
  Constructor 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$, ResultSet p_rs!)
```
  Constructor 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$, Collection p_collection!)
```
  Constructor 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$, JRDataSource p_jrdatasource!)
```
  Constructor 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$, BBjString p_connectString$, HashMap p_params!)
```
  Constructor 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$, ResultSet p_rs!, HashMap p_params!)
```
  Constructor 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$, Collection p_collection!, HashMap p_params!)
```
  Constructor 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$, JRDataSource p_jrdatasource!, HashMap p_params!)
```
  Constructor 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$, BBjString p_connectString$, HashMap p_params!, BBjString p_locale$)
```
  Constructor 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!, HashMap p_params!, BBjString p_locale$)
```
  Constructor 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!, HashMap p_params!, BBjString p_locale$)
```
  Constructor 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!, HashMap p_params!, BBjString p_locale$)
```
  Constructor 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
  - appendReport
```
public void appendReport(BBJasperReport p_report!)
```
    appendReport Appends the passed BBJasperReport to the current report
    
    Parameters:
    p_report! BBJasperReport object to append
    Since:
    13.0
  - cleanupVirtualization
```
public void cleanupVirtualization()
```
    cleanupVirtualization Removes temporary files that are created when virtualization is used.
    
    Since:
    19.00
  - clone
```
public BBnet.sf.jasperreports.engine.JasperReport clone()
```
    clone Creates and returns a copy of the current BBJasperReport object
    
    Returns:
    The cloned BBJasperReport object
  - createSubReport
```
public BBnet.sf.jasperreports.engine.JasperReport createSubReport(BBjString p_reportFile$, HashMap p_params!)
```
    createSubReport 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
  - destroy
```
public void destroy()
```
    destroy Destroys the BBJasperReport object
  - email
```
public void email(Email p_email!)
```
    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
  - exportToCSV
```
public void exportToCSV(BBjNumber p_onClient, BBjString p_filepath$)
```
    exportToCSV 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!)
```
    exportToCSV 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
  - exportToDOCX
```
public void exportToDOCX(BBjNumber p_onClient, BBjString p_filepath$)
```
    exportToDOCX 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!)
```
    exportToDOCX 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
  - exportToHTML
```
public void exportToHTML(BBjNumber p_onClient, BBjString p_filepath$)
```
    exportToHTML 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!)
```
    exportToHTML 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
  - exportToJRPRINT
```
public void exportToJRPRINT(BBjNumber p_onClient, BBjString p_filepath$)
```
    exportToJRPRINT 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
  - exportToODS
```
public void exportToODS(BBjNumber p_onClient, BBjString p_filepath$)
```
    exportToODS 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!)
```
    exportToODS 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
  - exportToODT
```
public void exportToODT(BBjNumber p_onClient, BBjString p_filepath$)
```
    exportToODT 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!)
```
    exportToODT 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
  - exportToPDF
```
public void exportToPDF(BBjNumber p_onClient, BBjString p_filepath$)
```
    exportToPDF 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!)
```
    exportToPDF 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
  - exportToPPTX
```
public void exportToPPTX(BBjNumber p_onClient, BBjString p_filepath$)
```
    exportToPPTX 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!)
```
    exportToPPTX 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
  - exportToRTF
```
public void exportToRTF(BBjNumber p_onClient, BBjString p_filepath$)
```
    exportToRTF 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!)
```
    exportToRTF 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
  - exportToTXT
```
public void exportToTXT(BBjNumber p_onClient, BBjString p_filepath$, BBjNumber p_pageWidth, BBjNumber p_pageHeight, BBjNumber p_charWidth, BBjNumber p_charHeight)
```
    exportToTXT 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!)
```
    exportToTXT 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
  - exportToXLS
```
public void exportToXLS(BBjNumber p_onClient, BBjString p_filepath$)
```
    exportToXLS 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)
```
    exportToXLS 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!)
```
    exportToXLS 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!)
```
    exportToXLS 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$)
```
    exportToXLSX 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!)
```
    exportToXLSX 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
  - exportToXML
```
public void exportToXML(BBjNumber p_onClient, BBjString p_filepath$, BBjNumber p_isEmbeddingImages)
```
    exportToXML 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!)
```
    exportToXML 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
  - fill
```
public BBjNumber fill()
```
    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)
```
    fill 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.
  - getClientJasperPrint
```
public net.sf.jasperreports.engine.JasperPrint@ getClientJasperPrint()
```
    getClientJasperPrint Creates (if necessary) and returns the client JasperPrint object
    
    Returns:
    Client JasperPrint object. The error CLIENT_OBJECT_ERROR can also be thrown.
  - getConnectString
```
public BBjString getConnectString()
```
    getConnectString Returns the JDBC connect string
    
    Returns:
    JDBC connect string
  - getDefaultFilePrefix
```
public BBjString getDefaultFilePrefix()
```
    getDefaultFilePrefix returns the default file prefix for temporary files like email attachements
    
    Returns:
    DefaultFilePrefix BASIS by default
  - getJasperPrint
```
public net.sf.jasperreports.engine.JasperPrint getJasperPrint()
```
    getJasperPrint Returns the JasperPrint object
    
    Returns:
    JasperPrint object
  - getJasperReport
```
public net.sf.jasperreports.engine.JasperReport getJasperReport()
```
    getJasperReport Returns the JasperReport object
    
    Returns:
    JasperReport object
  - getNumPages
```
public BBjNumber getNumPages()
```
    Returns the number of pages in the report
    
    Returns:
    The number of pages in the report
  - getParam
```
public Object getParam(BBjString p_key$)
```
    getParam Returns an individual parameter
    
    Parameters:
    p_key$ Report parameter key
    Returns:
    Report parameter value
  - getParams
```
public HashMap getParams()
```
    getParams Returns all report parameters
    
    Returns:
    Report parameters
  - getReportDir
```
public BBjString getReportDir()
```
    getReportDir Returns the report directory
    
    Returns:
    Report directory
  - getReportFile
```
public BBjString getReportFile()
```
    getReportFile Returns the report file
    
    Returns:
    Report file
  - print
```
public BBjNumber print(BBjNumber p_onClient, BBjNumber p_dialog)
```
    print 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!)
```
    print 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
  - putParam
```
public void putParam(BBjString p_key$, Object p_value!)
```
    putParam Sets an individual report parameter
    
    Parameters:
    p_key$ Report pareameter key
    p_value! Report pareameter value
  - putParams
```
public void putParams(HashMap p_hashMap!)
```
    putParams Sets report parameters
    
    Parameters:
    p_hashMap! Report parameters
  - registerJDBCDriver
```
public static Class registerJDBCDriver(BBjString p_jdbcDriverClass$)
```
    registerJDBCDriver Registers the passed JDBC driver class
    
    Parameters:
    p_jdbcDriverClass$ Name of the JDBC driver class to register
  - removeParam
```
public void removeParam(BBjString p_key$)
```
    removeParam Removes an individual report parameter
    
    Parameters:
    p_key$ Key of report parameter to remove
  - removeParams
```
public void removeParams()
```
    removeParams Removes all report parameters
  - setJasperReport
```
public void setJasperReport(net.sf.jasperreports.engine.JasperReport p_report!)
```
    setJasperReport Sets the working JasperReport object
    
    Parameters:
    p_report! A JasperReport object
  - setLocale
```
public void setLocale(Locale p_locale!)
```
    setLocale Sets the report locale parameter given a Java Locale object
    
    Parameters:
    p_locale! Specifies the Locale object to use for the report
    See Also:
    java.util.Locale
  - setLocale
```
public void setLocale(BBjString p_localeString$)
```
    setLocale Sets the report locale parameter given a string
    
    Parameters:
    p_localeString$ Specifies the locale as a string
  - setMaxPages
```
public void setMaxPages(BBjNumber p_maxPages)
```
    setMaxPages Sets the max number of report pages
    
    Parameters:
    p_maxPages Specifies the number of max pages
    Since:
    13.0
  - setupVirtualization
```
public void setupVirtualization()
```
    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)
```
    setupVirtualization 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$)
```
    setupVirtualization 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

Class BBJasperReport

Field Summary

Constructor Summary

Method Summary

Field Detail

CLIENT_OBJECT_ERROR=306

CONNECTION_ERROR=302

FILL_CANCELED=305

FILL_ERROR=304

REPORT_ERROR=301

SUCCESS=0

VIRTUALIZATION_THRESHOLD_SIZE=300

Constructor Detail

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

BBJasperReport

Method Detail

appendReport

cleanupVirtualization

clone

createSubReport

destroy

email

exportToCSV

exportToCSV

exportToDOCX

exportToDOCX

exportToHTML

exportToHTML

exportToJRPRINT

exportToODS

exportToODS

exportToODT

exportToODT

exportToPDF

exportToPDF

exportToPPTX

exportToPPTX

exportToRTF

exportToRTF

exportToTXT

exportToTXT

exportToXLS

exportToXLS

exportToXLS

exportToXLS

exportToXLSX

exportToXLSX

exportToXML

exportToXML

fill

fill

getClientJasperPrint

getConnectString

getDefaultFilePrefix

getJasperPrint

getJasperReport

getNumPages

getParam

getParams

getReportDir

getReportFile

print

print

putParam

putParams

registerJDBCDriver

removeParam

removeParams

setJasperReport

setLocale