com.crystaldecisions.sdk.occa.report.document
Interface IReportDocument

All Superinterfaces:
IClone, IDataDocument, IDocument
All Known Implementing Classes:
ReportDocument

public interface IReportDocument
extends IDataDocument

This interface enables you to get and set the report's definition, options, summary information, and major and minor versions.


Method Summary
 int getMajorVersion()
          Returns the major version number of the report's format.
 int getMinorVersion()
          Returns the minor version number of the report's format.
 IReportDefinition getReportDefinition()
          Returns IReportDefinition, which contains areas, sections, and report objects in the report.
 IReportOptions getReportOptions()
          Returns IReportOptions.
 ISummaryInfo getSummaryInfo()
          Returns the report's summary information.
 void setMajorVersion(int majorVersion)
          Sets the major version number of the report's format.
 void setMinorVersion(int minorVersion)
          Sets the minor version number of the report's format.
 void setReportDefinition(IReportDefinition reportDef)
          Sets IReportDefinition, which contains areas, sections, and report objects in the report.
 void setReportOptions(IReportOptions reportOptions)
          Sets IReportOptions.
 void setSummaryInfo(ISummaryInfo summaryInfo)
          Sets the report's summary information.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.document.IDataDocument
getDatabase, getDataDefinition, setDatabase, setDataDefinition
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.document.IDocument
getName, getOptions, getRemoteID, getTimestamp, getUID, setName, setOptions, setRemoteID, setTimestamp, setUID
 

Method Detail

getMajorVersion

int getMajorVersion()

Returns the major version number of the report's format.

Returns:
The major version number as an int.

getMinorVersion

int getMinorVersion()

Returns the minor version number of the report's format.

Returns:
The minor version number as an int.

getReportDefinition

IReportDefinition getReportDefinition()

Returns IReportDefinition, which contains areas, sections, and report objects in the report. This object provides access to areas in the report; each area may contain multiple sections, and each section may contain multiple report objects. A new report, by default, contains five area objects: the Report Header area, the Page Header area, the Details area, the Report Footer area, and the Page Footer area.

Returns:
The ReportDefinition object.

getReportOptions

IReportOptions getReportOptions()

Returns IReportOptions. Use IReportOptions to modify the report's behavior and capabilities such as how it should handle server data, dates, queries, printing, viewing, and other such options.

Returns:
IReportOptions as an object.

getSummaryInfo

ISummaryInfo getSummaryInfo()

Returns the report's summary information. The summary information consists of the author's name, comments, keywords, subject, title, and whether or not a preview image is saved.

Returns:
The ISummaryInfo object.

setMajorVersion

void setMajorVersion(int majorVersion)

Sets the major version number of the report's format.

Parameters:
majorVersion - The major version number as an int.

setMinorVersion

void setMinorVersion(int minorVersion)

Sets the minor version number of the report's format.

Parameters:
minorVersion - The minor version number as an int.

setReportDefinition

void setReportDefinition(IReportDefinition reportDef)

Sets IReportDefinition, which contains areas, sections, and report objects in the report. This property provides access to areas in the report; each area may contain multiple sections, and each section may contain multiple report objects. A new report, by default, contains five area objects: the Report Header area, the Page Header area, the Details area, the Report Footer area, and the Page Footer area.

Parameters:
reportDef - The ReportDefinition object.

setReportOptions

void setReportOptions(IReportOptions reportOptions)

Sets IReportOptions. Use IReportOptions to modify the report's behavior and capabilities such as how it should handle server data, dates, queries, printing, viewing, and other such options.

Parameters:
reportOptions - The IReportOptions object.

setSummaryInfo

void setSummaryInfo(ISummaryInfo summaryInfo)

Sets the report's summary information. The summary information consists of the author's name, comments, keywords, subject, title, and whether or not a preview image is saved.

Parameters:
summaryInfo - The ISummaryInfo object.