|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.crystaldecisions.reports.sdk.ReportClientDocument
A document object that represents a report.
Constructor Summary | |
ReportClientDocument()
Creates a new report client document. |
Method Summary | |
void |
close()
Closes the report client document. |
DatabaseController |
getDatabaseController()
Retrieves the database controller for the document. |
DataDefController |
getDataDefController()
Returns the data definition controller for the document. |
PrintOutputController |
getPrintOutputController()
Returns the PrintOutputController object used to export this
document to a different format. |
java.lang.String |
getRecordSelectionFormula()
Gets the record selection formula for this report. |
IReportSource |
getReportSource()
Returns a report source based on the current report document. |
SubreportController |
getSubreportController()
Retrieves the subreport controller for the document. |
boolean |
isOpen()
Returns true if the report client document is currently open. |
void |
open(java.lang.Object documentPath,
int options)
Opens a report specified by documentPath. |
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 for this report. |
void |
setRecordSelectionFormula(java.lang.String formulaText)
Sets the record selection formula for this report. |
void |
verifyDatabase()
Verifies all the datasources used in this report. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ReportClientDocument()
Method Detail |
public void open(java.lang.Object documentPath, int options) throws ReportSDKException
documentPath
- - One of the following:options
- - This argument is currently ignored. All reports are
opened as read-only
ReportSDKException
- if the document failed to open
java.lang.IllegalArgumentException
- if documentPath is not a valid objectpublic void close() throws ReportSDKException
ReportSDKException
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.
ReportSDKException
java.io.IOException
public DatabaseController getDatabaseController() throws ReportSDKException
getDatabaseController
in interface IReportClientDocument
ReportSDKException
public IReportSource getReportSource()
public boolean isOpen() throws ReportSDKException
ReportSDKException
public void setLocale(java.util.Locale locale) throws ReportSDKException
locale
-
ReportSDKException
- if the report client document is already
openpublic DataDefController getDataDefController() throws ReportSDKException
getDataDefController
in interface IReportClientDocument
ReportSDKException
public SubreportController getSubreportController() throws ReportSDKException
ReportSDKException
public PrintOutputController getPrintOutputController()
PrintOutputController
object used to export this
document to a different format.
PrintOutputController
object used to export this
document to a different format.public void verifyDatabase() throws ReportSDKException
ReportSDKException
public java.lang.String getRecordSelectionFormula() throws ReportSDKException
IReportClientDocument
getRecordSelectionFormula
in interface IReportClientDocument
ReportSDKException
public void setRecordSelectionFormula(java.lang.String formulaText) throws ReportSDKException
IReportClientDocument
setRecordSelectionFormula
in interface IReportClientDocument
formulaText
- The record selection formula for this report.
ReportSDKException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |