|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDataDefinition
This interface provides access the document's DataDefinition
. The
DataDefinition
contains all the fields and groups in the report. This is used to
define the structure of the data that is being retrieved from the database. In order to modify
any part of the report's data definition, you must access the DataDefinition object through the
DataDefController
object. If you want to access the DataDefinition
only to read it, you can also use
the ReportClientDocument
object.
The following table shows the differences in behavior associated with the different report filters:
Record Filter | Saved Data Filter | Group Filter | |
---|---|---|---|
Can refer to the summary? | No. | Yes. | Yes. |
When is the formula evaluated? | While reading records./td> | If a summary is used, at print time; otherwise, while reading records. | At print time. |
When is the report refreshed? | If the evaluation result is false, when records are dropped. | If records are being read, when evaluated. If the evaluation result is false, when records are dropped. | N/A |
Affects summary calculation? | Yes, records that are filtered out are not counted. | If the filter is evaluated while reading records, then no; otherwise, yes. | No, records are counted even when they are filtered out. |
Method Summary | |
---|---|
Alerts |
getAlerts()
For internal use only. |
CustomFunctions |
getCustomFunctions()
Returns a collection of the custom functions contained in a report. |
Fields<IFormulaField> |
getFormulaFields()
Returns an object that contains a list of all the formula fields in the report. |
IFilter |
getGroupFilter()
Returns the filter that indicates how groups are filtered in the report. |
Groups |
getGroups()
Returns an object that indicates how data is grouped in the report. |
Fields<IParameterField> |
getParameterFields()
Returns an object that contains the parameters in the report. |
IFilter |
getRecordFilter()
Returns the filter that determines which records should be retrieved from the database when data is retrieved. |
Sorts |
getRecordSorts()
Returns an object that indicates how records are sorted once they are retrieved from the database. |
Fields<IField> |
getResultFields()
Returns an object that contains the result fields in the report. |
Fields<IRunningTotalField> |
getRunningTotalFields()
For internal use only. |
IFilter |
getSavedDataFilter()
Returns the filter that allows users to view a subset of the data saved in a report. |
Sorts |
getSorts()
Deprecated. please use getRecordSorts() for record sorts, and IGroup.getSort()
for group sorts. |
SummaryFields<ISummaryField> |
getSummaryFields()
Returns an object that contains a list of the summaries in the report. |
IFilter |
getViewTimeFilter()
Returns the report filter that can be applied when viewing. |
void |
setFormulaFields(Fields<IFormulaField> formulaFields)
Sets an object that contains a list of all the formula fields in the report. |
void |
setGroupFilter(IFilter groupFilter)
Sets the filter that indicates how groups are filtered in the report. |
void |
setGroups(Groups groups)
Sets an object that indicates how data is grouped in the report. |
void |
setParameterFields(Fields<IParameterField> parameterFields)
Sets an object that contains the parameters in the report. |
void |
setRecordFilter(IFilter recordFilter)
Sets the filter that determines which records should be retrieved from the database when data is retrieved. |
void |
setRecordSorts(Sorts sorts)
Sets an object that indicates how records are sorted once they are retrieved from the database. |
void |
setResultFields(Fields<IField> resultFields)
Sets an object that contains the result fields in the report. |
void |
setRunningTotalFields(Fields<IRunningTotalField> runningTotalFields)
For internal use only. |
void |
setSavedDataFilter(IFilter savedDataFilter)
Sets a filter that allows users to view a subset of the data saved in a report. |
void |
setSorts(Sorts sorts)
Deprecated. please use setRecordSorts(com.crystaldecisions.sdk.occa.report.data.Sorts) for record sorts, and IGroup.setSort(com.crystaldecisions.sdk.occa.report.data.ISort)
for group sorts. |
Method Detail |
---|
Fields<IFormulaField> getFormulaFields()
Returns an object that contains a list of all the formula fields in the report. The formula
fields that are included in this list are not necessarily placed on the report. That is, you
may not see their values when the report is refreshed. To see whether a formula field has
been placed on the report, use the getResultFields()
method.
Fields
object.IFilter getGroupFilter()
Returns the filter that indicates how groups are filtered in the report.
IFilter
object.Groups getGroups()
Returns an object that indicates how data is grouped in the report. This object contains all the groups in a report.
Groups
object.Fields<IParameterField> getParameterFields()
Returns an object that contains the parameters in the report.
Fields
object.IFilter getSavedDataFilter()
Returns the filter that allows users to view a subset of the data saved in a report. Changing the SavedDataFilter will not discard the data saved in a report or result in a database hit.
IFilter
object.getSavedDataFilterController
IFilter getRecordFilter()
Returns the filter that determines which records should be retrieved from the database when data is retrieved.
IFilter
object.Fields<IField> getResultFields()
Returns an object that contains the result fields in the report.
Fields
object.Sorts getSorts()
getRecordSorts()
for record sorts, and IGroup.getSort()
for group sorts.
Returns an object that indicates how records are sorted once they are retrieved from the database.
Sorts
object.Sorts getRecordSorts()
IGroup.getSort()
.
Sorts
object.RecordSortController
SummaryFields<ISummaryField> getSummaryFields()
Returns an object that contains a list of the summaries in the report.
Fields
object.void setFormulaFields(Fields<IFormulaField> formulaFields)
Sets an object that contains a list of all the formula fields in the report. The formula
fields that are included in this list are not necessarily placed on the report. That is, you
may not see their values when the report is refreshed. To see whether a formula field has
been placed on the report, use the getResultFields()
method.
formulaFields
- Returns the Fields
object.void setGroupFilter(IFilter groupFilter)
Sets the filter that indicates how groups are filtered in the report.
groupFilter
- The group filter as an IFilter
object.void setGroups(Groups groups)
Sets an object that indicates how data is grouped in the report. This object contains all the groups in a report.
groups
- The Groups
object.void setParameterFields(Fields<IParameterField> parameterFields)
Sets an object that contains the parameters in the report.
parameterFields
- The Fields
object.void setSavedDataFilter(IFilter savedDataFilter)
Sets a filter that allows users to view a subset of the data saved in a report. Changing the SavedDataFilter will not discard the data saved in a report or result in a database hit.
savedDataFilter
- The saved data filter as an IFilter
object.void setRecordFilter(IFilter recordFilter)
Sets the filter that determines which records should be retrieved from the database when data is retrieved.
recordFilter
- The filter as an IFilter
object.void setResultFields(Fields<IField> resultFields)
Sets an object that contains the result fields in the report.
resultFields
- The Fields
object.void setSorts(Sorts sorts)
setRecordSorts(com.crystaldecisions.sdk.occa.report.data.Sorts)
for record sorts, and IGroup.setSort(com.crystaldecisions.sdk.occa.report.data.ISort)
for group sorts.
Sets an object that indicates how records are sorted once they are retrieved from the database.
sorts
- The Sorts
object.void setRecordSorts(Sorts sorts)
IGroup.setSort(com.crystaldecisions.sdk.occa.report.data.ISort)
.
sorts
- The Sorts
object.RecordSortController
Fields<IRunningTotalField> getRunningTotalFields()
For internal use only.
void setRunningTotalFields(Fields<IRunningTotalField> runningTotalFields)
For internal use only.
CustomFunctions getCustomFunctions()
Returns a collection of the custom functions contained in a report. Custom functions must be added to the report using Crystal Reports. For information on how to do this, see the Crystal Reports online help.
CustomFunctions
object containing a collection of custom functions.Alerts getAlerts()
IFilter getViewTimeFilter()
Returns the report filter that can be applied when viewing.
IFilter
object.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |