|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IReportClientDocument
This object provides access to the report data definition and controllers that are required to modify a subreport.
Use the SubreportController
object to import a report as a subreport, to add or
remove subreport links, or to retrieve the names of all of the subreports in a report. To access
the associated SubreportClientDocument
object, use the subreport name.
The SubreportObject
is defined in the
com.crystaldecisions.sdk.occa.report.definition package and should be used to access subreport
properties such as layout and formatting of the subreport.
Method Summary | |
---|---|
void |
checkDatabaseAndUpdate()
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()
Returns the CustomFunctionController object, which is used for modifying
custom functions in the report. |
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. |
java.util.Locale |
getLocale()
Returns the locale that is used to localize various aspects of the document. |
ReportClientDocument |
getMainReport()
For internal use only. |
java.lang.String |
getRecordSelectionFormula()
Retrieves the record selection formula for this report |
ReportDefController |
getReportDefController()
Returns the ReportDefController object, which is used to modify the report
definition's areas, sections, and report objects. |
IReportOptions |
getReportOptions()
Returns IReportOptions object, which specifies the subreport's behavior and
capabilities such a how it should handle server data, dates, queries, printing, viewing, and
other such options. |
IReportStatistics |
getReportStatistics()
Retrieves Report Statistics |
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)
Modifies the record selection formula for this report |
void |
verifyDatabase()
Checks to ensure that the report is using the most current data scheme from its database. |
Method Detail |
---|
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.
DatabaseController
object.
ReportSDKException
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.
DataDefController
object.
ReportSDKException
ReportDefController getReportDefController() throws ReportSDKException
Returns the ReportDefController
object, which is used to modify the report
definition's areas, sections, and report objects.
ReportDefController
object.
ReportSDKException
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.
RowsetController
object.
ReportSDKException
SearchController getSearchController() throws ReportSDKException
Returns the SearchController
object, which is used for searching the
subreport.
SearchController
object.
ReportSDKException
CustomFunctionController getCustomFunctionController() throws ReportSDKException
Returns the CustomFunctionController
object, which is used for modifying
custom functions in the report.
CustomFunctionController
object.
ReportSDKException
IUndoManager getUndoManager()
IReportOptions getReportOptions()
Returns IReportOptions
object, which specifies the subreport's behavior and
capabilities such a how it should handle server data, dates, queries, printing, viewing, and
other such options.
IReportOptions
object.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.
newOptions
- The subreport's options.
ReportSDKException
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 new field has been added to the database on the server, the new field is added
to the report but will not be displayed in the report's contents. If a field has been deleted
from the database, the field will also be deleted from the report. If the method fails, it
throws a ReportSDKException
containing the error code.
ReportSDKException
- This is thrown if the report fails to be updated from the
database. The exception will contain the error code given.void checkDatabaseAndUpdate() throws ReportSDKException
ReportSDKException
java.util.Locale getLocale()
Returns the locale that is used to localize various aspects of the document.
Locale
object.FormulaErrors checkFormula(IFormula formula) throws ReportSDKException
ReportSDKException
FormulaErrors checkFormula(IFormula formula, java.lang.String contextObjectName) throws ReportSDKException
ReportSDKException
FormulaErrors checkFormula(IFormula formula, java.lang.String contextObjectName, java.lang.String containerCrosstabName) throws ReportSDKException
ReportSDKException
FormulaLanguageService getFormulaLanguageService()
java.lang.String getRecordSelectionFormula() throws ReportSDKException
ReportSDKException
void setRecordSelectionFormula(java.lang.String formula) throws ReportSDKException
formula
- The record selection formula for this report.
ReportSDKException
IReportStatistics getReportStatistics() throws ReportSDKException
ReportSDKException
ReportClientDocument getMainReport()
RepositoryService getRepositoryService()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |