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

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

See:
          Description

Interface Summary
IEnterprisePlugin This interface is used to provide BusinessObjects Enterprise specific information to EROM components in the managed case.
IFieldFilter For internal use only.
ISubreportClientDocument This object provides access to the report data definition and controllers that are required to modify a subreport.
 

Class Summary
AdvancedReportSource For internal use only.
ClientDocument This abstract class represents a general Report Application Server document.
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  
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.
NonDCPAdvancedReportSource For internal use only.
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 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.
ReportAppSession Use ReportAppSession 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 a variety of operations on a report, in addition to saving, copying, and closing.
ReportClientDocumentState For internal use only.
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 This object is used to modify the way in which data in the report is sorted.
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. 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. It is also used to connect to a specified RAS server and to provide information about the nature of the installed SDK.

A RAS server can operate either as a stand-alone server or as a server that is connected to BusinessObjects Enterprise. If you want to use the stand-alone version of RAS or add-in version to connect to a RAS server, use the ReportAppSession object; if you are using the add-in, use the ReportAppSession object to establish a connection to the Crystal APS. The ReportClientDocument object can still be used to establish a connection, but this object is only supported for compatibility with an earlier version of RAS.

Controllers

This package also contains controllers that are used to manipulate the report's database, data definition, and report definition. Along with the controllers, this package contains the ConnectionDirManager object, which is a tree structure that allows users to browse a server for available report documents and data sources.

In most cases, the objects, controllers, and collections in this package are used in conjunction with those in the Data package and Definition package. Although the Data package and Definition package provide functionality similar to this package, they will 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. The following table describes which controller you should use to modify an object:

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

All fields that are displayed in the report.

RowsetController Rowset
SubreportController

SubreportObject.

SearchController Rowset
SortController Sort
SummaryField SummaryField

Note: The primary controller is the DataDefController, which is the object from which the controllers for the data definition objects can be retrieved.

Related Documentation