Package com.crystaldecisions.sdk.occa.report.data

This package is used to provide a definition for the report's data.

See:
Description

Interface Summary

IAlert	This interface represents an alert contained in a report.
ICommandTable	Interface for the CommandTable object.
IConnection	This interface contains information about a data source connection and the tables that belong to it.
IConnectionDirectory	This interface is used to get and set information for a connection directory.
IConnectionDirectoryItem	This interface enables you to retrieve and set the connection.
IConnectionInfo	This interface enables you to get and set information for the data source connection.
IConstantValue	This interface represents a literal value that needs no evaluation.
ICursor	This interface is used to navigate through the records in a record batch.
ICustomFunction	This interface enables you to set and retrieve information about a custom function.
IDatabase	This interface defines a collection of tables from one or more database servers as well as a collection of TableLink objects that define how the tables are linked.
IDataConditionFormula	This interface enables you to set the condition formula for each of the attributes for a selected area, section, or report object, thus offering you full conditional control over the appearance of the report object and its area and section.
IDataDefinition	This interface provides access the document's DataDefinition.
IDataSet	The DataSet object is a runtime data source that determines the set of data that is displayed by a report.
IDateGroupOptions	This interface is used to define options that are available if data is grouped by a date field.
IDBField	This interface represents a database field.
IDirectoryItem	This interface defines an item under the data sources directory.
IExpressionValue	This interface is used to get and set an ExpressionValue.
IField	This interface defines a report field in general.
IFieldRangeFilterItem	This interface is used to represent a primitive expression in a filter string.
IFilter	This interface defines filters that are used in record selection and group selection.
IFilterItem	Interface for the FilterItem object.
IFormulaField	This interface defines a formula field in the report.
IGroup	This interface enables you to get and set the options and conditions for how data is grouped in the report and which options are set for the group.
IGroupNameField	This interface defines a group name field.
IGroupOptions	Interface for the GroupOptions object.
IGroupPath	This interface is used to identify the location of a node in the totaller tree.
IOperatorFilterItem	This interface defines an operator that is used to combine two primitive expressions in a filter's parsed formula string.
IParameterField	This interface is used to get and set values for the parameter field.
IParameterFieldDiscreteValue	This interface is used to get and set a discrete value belonging to a parameter.
IParameterFieldRangeValue	This interface is used to get and set values for a ranged parameter.
IParameterFieldValue	This interface enables you to get and set a parameter's description.
IProcedure	This interface is used to get and set the current values for the parameters of stored procedures.
IRecordBatch	This interface enables you to get information about records in the record batch.
IRowset	This interface is used to get and set values for a set of rows from a table of data.
IRowsetMetaData	This interface is used to get and set the fields that are used to populate the columns in a rowset.
ISort	This interface is used to get and set how data is sorted.
ISpecialField	This interface allows you to add date and time fields into your report.
ISpecifiedGroupOptions	This interface is used to get and set values for data that is grouped according to user-specified options.
ISummaryField	This interface is used to calculate a summary for a group, or for the entire report.
ITable	This interface defines a table from a database.
ITableLink	This interface defines a link between two tables.
ITopNSort	This interface defines a Top N sort order.
ITotallerNode	This interface defines a node from the totaller tree.
IValue	This interface is used as a base class to represent different kinds of values (values in formulas, parameters, and so on).
IXMLDataSet	The XMLDataSet object is a runtime data source that determines the set of data that is displayed by a report.

Class Summary

Alert	This object represents an alert contained in a report.
Alerts	This object represents a collection of alerts objects defined in a report.
CommandTable	This object allows you to construct an SQL statement and add it to a report's database as a table.
CompositeCursor	This object is used when there are multiple cursors.
Connection	This object contains information about a data source connection and the tables that belong to it.
ConnectionDirectory	This object is used to get and set information for a connection directory.
ConnectionDirectoryItem	This object enables you to retrieve and set the connection.
ConnectionInfo	This object enables you to get and set information for the data source connection.
ConnectionInfoKind	This class contains constants that specify what type of database connection has been made.
ConnectionInfos	This object returns connection information.
ConstantValue	This object represents a literal value that needs no evaluation.
CursorType	This object defines the cursor type.
CustomFunction	This object enables you to set and retrieve information for custom functions.
CustomFunctions	This object is a custom function collection.
Database	This object contains a collection of tables from one or more database servers as well as a collection of TableLink objects that define how the tables are linked.
DataConditionFormula	Use the methods of this object to set the condition formula for the attributes of a selected DataDefinition object.
DataDefinition	This object contains the DataDefinition.
DataSet	The DataSet object is a runtime data source that determines the set of data that is displayed by a report.
DateCondition	This object defines how data is grouped if the group is sorted by a date field.
DateGroupOptions	This object is used to contain options that are available if data is grouped by a date field.
DBField	This object represents a database field.
DirectoryItem	This object implements an item under the data sources directory.
DirectoryItems	This collection contains an array of DirectoryItem objects.
DirectoryItemType	This class is used to specify the type of a directory item.
ExpressionValue	This object represents a value that needs to be evaluated.
FetchedRecordCountInfo	This object is used to determine key properties of fetched records.
Field	This object represents a report field in general.
FieldDisplayNameType	This class contains constants that indicate how the name of the field is displayed.
FieldKind	This class contains constants which indicate the kind of a particular field.
FieldRangeFilterItem	This object is used to represent a primitive expression in a filter string.
Fields	This object stores an array of fields.
FieldValueType	This class contains constants that indicate what type of data is stored by the field.
Filter	This object defines filters that are used in record selection and group selection.
FilterItem	This abstract class is used to represent an item in a formula string.
FilterItems	This object is used to contain a list of FieldRangeFilterItem and OperatorFilterItem objects that contain parsed information about a filter string.
Filters	This object defines a collection of Filter objects.
FormulaField	This object implements a formula field in the report.
FormulaFieldOptions	This class contains constants for the formula field options and methods for using these constants.
FormulaNullTreatment	This class contains constants that specify how to treat nulls in a formula.
FormulaSyntax	This class defines the syntax of a formula.
Group	This object defines a group in the report.
GroupNameField	This object implements a group name field.
GroupOptions	This class is used as a base class for groups that group data according to specific options, or for unusual fields that require options.
GroupOptionsConditionFormulas	This class stores a collection of condition formulas for properties of the GroupOptions object.
GroupOptionsConditionFormulaType	This class contains constants that specify the condition formula type for group options.
GroupPath	This object is used to identify the location of a node in the totaller tree.
Groups	This object defines a Groups collection object.
OperatorFilterItem	This object implements an operator that is used to combine two primitive expressions in a filter's parsed formula string.
ParameterField	This object enables you to get and set values for the parameter field.
ParameterFieldDiscreteValue	This object represents a discrete value belonging to a parameter.
ParameterFieldRangeValue	This object stores the value for a ranged parameter.
ParameterFieldType	This class contains constants for the parameter field type and methods for using these constants.
ParameterFieldUsage	For internal use only.
ParameterFieldValue	This object represents a parameter field value.
ParameterSortMethod	This class contains constants that specify how the parameters are sorted.
ParameterSortOrder	This class contains constants that indicate how a parameter list is sorted.
ParameterValueRangeKind	This class contains constants that indicate whether the parameter is discrete, ranged, or both.
Procedure	This object represents a procedure that is stored in the database.
RangeValueBoundType	This class contains constants that indicate the range bound; that is, how the bound on a range is treated.
Record	This object defines a record from a database.
RecordBatch	This object stores a batch of records from the database.
RecordBatches	This object defines a collection of record batches.
Records	This object contains a list of records.
Rowset	This object stores a set of rows from a table of data.
RowsetMetaData	This object indicates which fields are used to populate the columns in a rowset.
Rowsets	This object defines a collection that contains a list of Rowset objects.
SelectionOperation	This class defines a selection operation in a formula.
Sort	This object is used to indicate how data is sorted.
SortDirection	This class contains constants that define how fields are sorted.
Sorts	This object stores a collection of Sort objects that indicate how the rowset in the report should be sorted.
SpecialField	This object allows you to add date and time fields into your report.
SpecialFieldType	This class contains constants that indicate what kind of special field is being used.
SpecifiedGroupOptions	This object is used to store options for data that is grouped according to user-specified options.
SummaryField	This object is used to calculate a summary for a group, or for the entire report.
SummaryFields	This object defines a collection of SummaryField objects.
SummaryOperation	This class contains constants that define how a summary is performed.
Table	This object implements a table from a database.
TableJoinType	This class contains constants that indicate how tables are linked, specifically the join type.
TableLink	This object implements a link between two tables.
TableLinks	This object defines a collection of TableLink objects.
Tables	This object contains a collection of database tables.
TopNConditionFormulas
TopNConditionFormulaType	This class contains constants that specify the condition formula type for Top N sorting.
TopNSort	This object implements a Top N sort order.
TotallerNode	This object implements a node from the totaller tree.
TotallerNodeOptions	This class is used to store information about a totaller node.
TotallerNodes	This object defines a collection of totaller nodes.
UnspecifiedValuesType	This class contains constants that indicate what should be done with records that do not fall under a specified group.
Value	This object defines a value of a field.
Values	This object defines a collection that contains an array of Value objects and allows you to add, remove, search for, and add new values to and from the collection.
XMLDataSet	The XMLDataSet object is a runtime data source that determines the set of data that is displayed by a report.

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

This package is used to provide a definition for the report's data. It contains all the data structures necessary to define the data that the report contains. It is concerned with the retrieval of data, where and how this data is stored, the structures that are used to store the data while processing it, and the structures that are used to store it once it is processed. 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, text objects, and so on. For this information, see the Crystal Reports Report Definition Model Library.

The primary object used to contain the entire data definition is the DataDefinition object. It is the object from which most other data structures in the report may be retrieved.

Although this library provides functionality to modify and manipulate the data definition, it will not synchronize the data that your Report Application Server client is manipulating with the data on the server. In order to properly modify the report and ensure that your RAS client is being synchronized with the server, you must use the appropriate controller in com.crystaldecisions.sdk.occa.report.application .

The following table indicates which controller to use to modify specific objects:

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	A subreport's Table.
SearchController	Rowset
SortController	Sort
SummaryFieldController	SummaryField

Related Documentation

• Reference Guide
• Object Model Diagram
  Expandable in Netscape 6.2 and Internet Explorer 5.5+