Package com.crystaldecisions.sdk.occa.report.application

This package controls the manipulation of supported Report Application Server documents.

See:
          Description

Interface Summary
IClientDocumentEventListener This interface contains methods that provide event handling for ClientDocumentEvents.
IEnterprisePlugin This interface is used to provide information specific to objects in a SAP BusinessObjects Enterprise environment.
IReportClientDocument This object provides access to the report definition, data definition and controllers that are required to modify a report.
ISubreportClientDocument This object provides access to the report data definition and controllers that are required to modify a subreport.
 

Class Summary
AbstractRowsetCursor For internal use only.
ClientDocument This abstract class represents a general Report Application Server document.
ClientDocumentEvent This class defines an event that represents a report modification.
ClientDocumentPropertyChangeType This class defines the type of a document properties.
ConnectionDirManager This class defines the Connection Directory Manager.
CustomFunctionController This object enables you to retrieve and modify custom functions in a report.
DatabaseController This object is used to manipulate the Database objects that are contained in a report.
DataDefController This object is used to add, remove, and modify the data definition of the report.
DBOptions This class defines database options.
FilterController This object is used to modify filters in a report.
FormulaFieldController This object is used to add, remove, and modify report formulas.
GroupController This object is used to add, remove, and modify groups in a report.
GroupSortController This class is used to modify how groups are sorted in a report.
OpenReportOptions This object contains options that can be specified when opening a report.
ParameterFieldController This object is used to add, remove, and modify parameter fields and parameter groups in a report.
PrintOutputController This object is used to export reports to a specific format, such as Microsoft Excel (97-2003), Rich Text Format (RTF), or PDF and to modify various formatting options.
RecordSortController This class is used to modify how records are sorted in a report.
ReportAppSession Use the ReportAppSession class to establish a connection to a specific RAS server.
ReportAreaController This object is used to set the properties for areas in the report.
ReportAreaPropertyEnum This class defines report area constants.
ReportClientDocument This object enables you to perform operations on a report, including saving, copying, and closing a report.
ReportDefController This object is used to modify areas and sections in a report, as well as format report objects such as fields, pictures, and charts.
ReportObjectController This object is used to add, remove, and modify the report objects that are defined in the definition package.
ReportSaveAsOptions This object contains options that can be specified when saving a report using a specified filename.
ReportSectionController This object is used to add, remove, and set the properties for sections in the report.
ReportSectionPropertyEnum This class defines report section constants.
ResultFieldController This object is used to add, remove, and move result fields in a report.
RowsetController This object is used to retrieve unformatted data in the report directly.
RowsetCursor This object provides easy access to records in a rowset.
RowsetRefreshOptions This class defines options specified by the RowsetController object's getRefreshOptions and setRefreshOptions methods.
SearchController This object is used to perform searches on the data in the report.
SearchResultCursor This object is used to navigate the results of a search.
SendOneRequestHelper This class allows RASReportAppFactory in 'cereports.jar' to access the RemoteAgent functionality in 'rasapp.jar'.
SortController Deprecated. As of version 4.0.
SubreportController Use the SubreportController object to import a report as a subreport and to add or remove subreport links.
SummaryFieldController This object is used to add, remove, and modify summary fields in a report.
 

Package com.crystaldecisions.sdk.occa.report.application Description

This package controls the manipulation of supported Report Application Server documents. This package contains controllers that are used to manipulate the database, data definition, and report definition. It is the central point from which all other packages and classes in the SDK are accessed and provides a starting point from which you can open, modify, and save documents, as well as obtain information about the format and nature of these documents.

Controllers

In most cases, the objects, controllers, and collections in this package are used in conjunction with the classes in the Data package and the Definition package. Although the Data package and the Definition package provide functionality similar to the Application package, they do not synchronize the data to the report engine. In order to properly modify the report, you must use the appropriate controller in the Application package instead of modifying report objects directly through the Data and the Definition packages.
The following table describes which controllers modify which report objects:

Controller Object
ChartObjectController ChartObject
CustomFunctionController CustomFunction
DatabaseController Database
DataDefController DataDefinition
FilterController Filter
FormulaFieldController FormulaField
GroupController Group
GroupSortController Sort
ParameterFieldController ParameterField
RecordSortController Sort
ReportAreaController Area
ReportObjectController ReportObject
ReportSectionController Section
ResultFieldController

All fields that are displayed in the report.

SubreportController

SubreportObject

SummaryFieldController SummaryField

Note: The primary controller is the DataDefController, which can be used to get the controllers for the data definition objects.