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

All Superinterfaces:
IReportClientDocument

public interface ISubreportClientDocument
extends 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
 boolean getEnableOnDemand()
          Returns whether or not the subreport is an on-demand subreport.
 java.lang.String getName()
           Returns the identifier of the subreport
 void setEnableOnDemand(boolean enableOnDemand)
          Sets whether or not the subreport is an on-demand subreport.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.application.IReportClientDocument
checkDatabaseAndUpdate, checkFormula, checkFormula, checkFormula, getCustomFunctionController, getDatabaseController, getDataDefController, getFormulaLanguageService, getLocale, getMainReport, getRecordSelectionFormula, getReportDefController, getReportOptions, getReportStatistics, getRepositoryService, getRowsetController, getSearchController, getUndoManager, modifyReportOptions, setRecordSelectionFormula, verifyDatabase
 

Method Detail

getName

java.lang.String getName()

Returns the identifier of the subreport

Returns:
The identifier of the subreport as a String object.

getEnableOnDemand

boolean getEnableOnDemand()
                          throws ReportSDKException

Returns whether or not the subreport is an on-demand subreport.

On-demand subreports appear only as hyperlinks in the main report.

The actual data is not read from the database until the user drills down on the hyperlink. Only data for the on-demand subreport that is actually viewed will be retrieved from the database. On-demand subreports may also be called "real time" subreports in some cases.

Returns:
true if the subreport is an on-demand subreport, and false otherwise.
Throws:
ReportSDKException

setEnableOnDemand

void setEnableOnDemand(boolean enableOnDemand)
                       throws ReportSDKException

Sets whether or not the subreport is an on-demand subreport.

On-demand subreports appear only as hyperlinks in the main report.

The actual data is not read from the database until the user drills down on the hyperlink. Only data for the on-demand subreport that is actually viewed will be retrieved from the database. On-demand subreports may also be called "real time" subreports in some cases.

Parameters:
enableOnDemand - true if the subreport is an on-demand subreport, and false otherwise.
Throws:
ReportSDKException