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

All Superinterfaces:
IClone, IDocument
All Known Subinterfaces:
IReportDocument
All Known Implementing Classes:
DataDocument, ReportDocument

public interface IDataDocument
extends IDocument

This interface enables you to get and set the database and the data definition.


Method Summary
 IDatabase getDatabase()
          Returns the database object.
 IDataDefinition getDataDefinition()
          Returns the DataDefinition.
 void setDatabase(IDatabase database)
          Sets the database object.
 void setDataDefinition(IDataDefinition dataDefinition)
          Sets the DataDefinition.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.document.IDocument
getName, getOptions, getRemoteID, getTimestamp, getUID, setName, setOptions, setRemoteID, setTimestamp, setUID
 

Method Detail

getDatabase

IDatabase getDatabase()

Returns the database object. This object contains the tables and fields available in the report. To modify any database property, you must use the methods in the DatabaseController. These methods also allow you to add and remove tables or fields.

Returns:
The database object as a com.crystaldecisions.ras.datamodel.IDatabase object.

getDataDefinition

IDataDefinition getDataDefinition()

Returns the DataDefinition. Returns an object containing formulas, filters, groups, parameters, sort objects, and summaries. The DataDefinition contains all the data structures necessary to define and manipulate the data that the report contains. Note that the report's data definition is not concerned with how the report is laid out. That is, it does not store information regarding graphics, charts, borders, or text objects. Although the DataDefinition represents the data in a report, it does not synchronize the data that your Report Application Server client is manipulating with that on the server. In order to properly modify the report, you must use the appropriate controller.

Returns:
The com.crystaldecisions.sdk.occa.report.data.IDataDefinition object.

setDatabase

void setDatabase(IDatabase database)

Sets the database object. This object contains the tables and fields available in the report. To modify any database property, you must use the methods in the DatabaseController. These methods also allow you to add and remove tables or fields.

Parameters:
database - The database as a com.crystaldecisions.sdk.occa.report.data.IDatabase object.

setDataDefinition

void setDataDefinition(IDataDefinition dataDefinition)

Sets the DataDefinition. Returns an object containing formulas, filters, groups, parameters, sort objects, and summaries. The DataDefinition contains all the data structures necessary to define and manipulate the data that the report contains. Note that the report's data definition is not concerned with how the report is laid out. That is, it does not store information regarding graphics, charts, borders, or text objects. Although the DataDefinition represents the data in a report, it does not synchronize the data that your Report Application Server client is manipulating with that on the server. In order to properly modify the report, you must use the appropriate controller.

Parameters:
dataDefinition - The com.crystaldecisions.sdk.occa.report.data.IDataDefinition object.