com.crystaldecisions.sdk.occa.report.application
Interface IReportClientDocument

All Known Subinterfaces:
ISubreportClientDocument
All Known Implementing Classes:
ReportClientDocument

public interface IReportClientDocument

This object provides access to the report definition, data definition and controllers that are required to modify a report.


Method Summary
 void checkDatabaseAndUpdate(VerifyDatabaseFeedbacks verifyDatabaseFeedbacks)
          For internal use only.
 FormulaErrors checkFormula(IFormula formula)
          For internal use only.
 FormulaErrors checkFormula(IFormula formula, java.lang.String contextObjectName)
          For internal use only.
 FormulaErrors checkFormula(IFormula formula, java.lang.String contextObjectName, java.lang.String containerCrosstabName)
          For internal use only.
 CustomFunctionController getCustomFunctionController()
          For internal use only
 DatabaseController getDatabaseController()
           Returns the DatabaseController object, which is used to add, remove, and modify the tables that are used as the subreport's data source.
 DataDefController getDataDefController()
           Returns the DataDefController object, which is used to modify the subreport's data definition.
 FormulaLanguageService getFormulaLanguageService()
          For internal use only.
 IAuditResult getLastAuditResult()
          For internal use only.
 java.util.Locale getLocale()
          For internal use only
 ReportClientDocument getMainReport()
          For internal use only.
 java.util.Locale getPreferredViewingLocale()
          For internal use only
 PrintOutputController getPrintOutputController()
          For internal use only.
 java.util.Locale getProductLocale()
          For internal use only
 java.lang.String getRecordSelectionFormula()
          For internal use only
 ReportDefController getReportDefController()
           Returns the ReportDefController object, which is used to modify the report definition's areas, sections, and report objects.
 IReportOptions getReportOptions()
          For internal use only.
 IReportStatistics getReportStatistics()
          For internal use only
 RepositoryService getRepositoryService()
          For internal use only.
 RowsetController getRowsetController()
           Returns the RowsetController object, which is used to browse field and table values in the database that the subreport is using and to fetch group tree and rowset data.
 SearchController getSearchController()
           Returns the SearchController object, which is used for searching the subreport.
 IUndoManager getUndoManager()
          For internal use only.
 void modifyReportOptions(IReportOptions newOptions)
           Modifies the report's behavior and capabilities such as how it should handle server data, dates, queries, printing, viewing, and other such options.
 void setRecordSelectionFormula(java.lang.String formula)
          For internal use only
 void verifyDatabase()
          For internal use only
 

Method Detail

getDatabaseController

DatabaseController getDatabaseController()
                                         throws ReportSDKException

Returns the DatabaseController object, which is used to add, remove, and modify the tables that are used as the subreport's data source.

Returns:
A DatabaseController object.
Throws:
ReportSDKException

getDataDefController

DataDefController getDataDefController()
                                       throws ReportSDKException

Returns the DataDefController object, which is used to modify the subreport's data definition.

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

Returns:
A DataDefController object.
Throws:
ReportSDKException

getReportDefController

ReportDefController getReportDefController()
                                           throws ReportSDKException

Returns the ReportDefController object, which is used to modify the report definition's areas, sections, and report objects.

Returns:
A ReportDefController object.
Throws:
ReportSDKException

getRowsetController

RowsetController getRowsetController()
                                     throws ReportSDKException

Returns the RowsetController object, which is used to browse field and table values in the database that the subreport is using and to fetch group tree and rowset data.

Returns:
A RowsetController object.
Throws:
ReportSDKException

getSearchController

SearchController getSearchController()
                                     throws ReportSDKException

Returns the SearchController object, which is used for searching the subreport.

Returns:
A SearchController object.
Throws:
ReportSDKException

getCustomFunctionController

CustomFunctionController getCustomFunctionController()
                                                     throws ReportSDKException
For internal use only

Throws:
ReportSDKException

getPrintOutputController

PrintOutputController getPrintOutputController()
                                               throws ReportSDKException
For internal use only.

Throws:
ReportSDKException

getUndoManager

IUndoManager getUndoManager()
For internal use only.


getReportOptions

IReportOptions getReportOptions()
For internal use only.


modifyReportOptions

void modifyReportOptions(IReportOptions newOptions)
                         throws ReportSDKException

Modifies the report's behavior and capabilities such as how it should handle server data, dates, queries, printing, viewing, and other such options.

Parameters:
newOptions - The subreport's options.
Throws:
ReportSDKException

verifyDatabase

void verifyDatabase()
                    throws ReportSDKException
For internal use only

Throws:
ReportSDKException

checkDatabaseAndUpdate

void checkDatabaseAndUpdate(VerifyDatabaseFeedbacks verifyDatabaseFeedbacks)
                            throws ReportSDKException
For internal use only.

Throws:
ReportSDKException

getLocale

java.util.Locale getLocale()
For internal use only


getProductLocale

java.util.Locale getProductLocale()
For internal use only


getPreferredViewingLocale

java.util.Locale getPreferredViewingLocale()
For internal use only


checkFormula

FormulaErrors checkFormula(IFormula formula)
                           throws ReportSDKException
For internal use only.

Throws:
ReportSDKException

checkFormula

FormulaErrors checkFormula(IFormula formula,
                           java.lang.String contextObjectName)
                           throws ReportSDKException
For internal use only.

Throws:
ReportSDKException

checkFormula

FormulaErrors checkFormula(IFormula formula,
                           java.lang.String contextObjectName,
                           java.lang.String containerCrosstabName)
                           throws ReportSDKException
For internal use only.

Throws:
ReportSDKException

getFormulaLanguageService

FormulaLanguageService getFormulaLanguageService()
For internal use only.


getRecordSelectionFormula

java.lang.String getRecordSelectionFormula()
                                           throws ReportSDKException
For internal use only

Throws:
ReportSDKException

setRecordSelectionFormula

void setRecordSelectionFormula(java.lang.String formula)
                               throws ReportSDKException
For internal use only

Throws:
ReportSDKException

getReportStatistics

IReportStatistics getReportStatistics()
                                      throws ReportSDKException
For internal use only

Throws:
ReportSDKException

getMainReport

ReportClientDocument getMainReport()
For internal use only.


getRepositoryService

RepositoryService getRepositoryService()
For internal use only.


getLastAuditResult

IAuditResult getLastAuditResult()
                                throws ReportSDKException
For internal use only.

Throws:
ReportSDKException