com.crystaldecisions.reports.sdk
Class ReportClientDocument

java.lang.Object
  |
  +--com.crystaldecisions.reports.sdk.ReportClientDocument

public class ReportClientDocument

extends java.lang.Object

Provides access to a report's properties.

Constructor Summary

ReportClientDocument()

Method Summary

void	close() Closes the ReportClientDocument and releases all resources.
DatabaseController	getDatabaseController() Returns the DatabaseController object that is used to access the tables that are used as the report's data source.
DataDefController	getDataDefController() Returns the DataDefController object used to modify the report's data definition.
PrintOutputController	getPrintOutputController() Returns the PrintOutputController object used to export this document to a different format.
IReportSource	getReportSource() Returns the ReportSource object used by the viewer to display the contents of the report.
SubreportController	getSubreportController() Returns the SubreportController object used to determine the names of the subreports in the report and to modify the subreports' databases.
boolean	isOpen() Returns true if this document is open, and false otherwise.
void	open(java.lang.Object documentPath, int options) Opens a report.
void	saveAs(java.lang.String displayName, java.lang.Object parentFolderPath, int options) Saves the changes to a new report.
void	setLocale(java.util.Locale locale) Sets the locale that is used to localize various aspects of the document.
void	verifyDatabase() Checks to ensure that the report is using the most current data scheme from its database.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportClientDocument

public ReportClientDocument()

Method Detail

open

public void open(java.lang.Object documentPath,
                 int options)
          throws ReportSDKException

Opens a report.

Parameters:

documentPath - Specifies the report to open. Can be one of: a String representing the URI for a report file, or a PropertyBag that contains a String representing the URI for a report file.

options - This parameter is currently ignored; all reports are opened as read-only.

Throws:

ReportSDKException - if the document fails to open

java.lang.IllegalArgumentException - if documentPath is not valid

close

public void close()
           throws ReportSDKException

Closes the ReportClientDocument and releases all resources.

Throws:

ReportSDKException - if the document fails to close

saveAs

public void saveAs(java.lang.String displayName,
                   java.lang.Object parentFolderPath,
                   int options)
            throws ReportSDKException,
                   java.io.IOException

Saves the changes to a new report.

If the report is saved successfully, the ReportClientDocument will point to the newly saved report. The saveAs method fails when a report of the same name exists and the saveAs option flag is not ReportSaveAsOptions._overwriteExisting

Parameters:

displayName - The name of the file. This parameter is required for this version.

parentFolderPath - This parameter specifies the pathname to the folder where the report is saved.

If the report contains processing extensions and it is saved, the processing extensions are not preserved. However, the report's selection formulas are modified to apply the data filtering rules enforced by the processing extensions. For information on applying processing extensions to a report, see the BusinessObjects Enterprise Administrator's Guide.

options - Specifies how the file should be saved. If this value is not included, this method will attempt to save the file in the current version without overwriting existing files. For valid options, see ReportSaveAsOptions.

Throws:

ReportSDKException

java.io.IOException

getDatabaseController

public DatabaseController getDatabaseController()
                                         throws ReportSDKException

Returns the DatabaseController object that is used to access the tables that are used as the report's data source.

Returns:

The DatabaseController object that is used to access the tables that are used as the report's data source.

Throws:

ReportSDKException

getReportSource

public IReportSource getReportSource()

Returns the ReportSource object used by the viewer to display the contents of the report.

Returns:

The IReportSource object or null if the ReportSource could not be retrieved

isOpen

public boolean isOpen()
               throws ReportSDKException

Returns true if this document is open, and false otherwise.

Returns:

true if this document is open, and false otherwise.

Throws:

ReportSDKException

setLocale

public void setLocale(java.util.Locale locale)
               throws ReportSDKException

Sets the locale that is used to localize various aspects of the document.

Note: The locale must be set before the ReportClientDocument is opened.

Parameters:

locale - The Locale object that is used to localize the document.

Throws:

ReportSDKException - if the ReportClientDocument is already open

getDataDefController

public DataDefController getDataDefController()
                                       throws ReportSDKException

Returns the DataDefController object used to modify the report's data definition.

A data definition defines what data is used in the report and how it is treated. Use the DataDefController object to modify the report's databases, formula fields, groups, parameter fields, record filters, and sorting definition.

Returns:

The DataDefController object used to modify the report's data definition.

Throws:

ReportSDKException

getSubreportController

public SubreportController getSubreportController()
                                           throws ReportSDKException

Returns the SubreportController object used to determine the names of the subreports in the report and to modify the subreports' databases.

Throws:

ReportSDKException

getPrintOutputController

public PrintOutputController getPrintOutputController()

Returns the PrintOutputController object used to export this document to a different format.

Returns:

The PrintOutputController object used to export this document to a different format.

verifyDatabase

public void verifyDatabase()
                    throws ReportSDKException

Checks to ensure that the report is using the most current data scheme from its database. If the scheme of the database on the server have been changed, the report is automatically updated. If a field has been deleted from the database, the field will also be deleted from the report. If the database field type has changed, an attempt is made to map the old field type to a new type. If the method fails, it throws a ReportSDKException containing the error code.

Throws:

ReportSDKException