com.crystaldecisions.sdk.occa.report.data
Interface IGroup

All Superinterfaces:
IClone
All Known Implementing Classes:
Group

public interface IGroup
extends IClone

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. The options that control how data is grouped depend on the type of field that is used in the grouping. For example, if a date field is used to group data, it will have options specific to sorting dates. It is also possible to group data using a specific, user-defined group order. The Options property stores the grouping options.

Depending on the grouping options required, the Options property will be one of the following:

Group Options Object Type
Normal group No options
Specified grouping SpecifiedGroupOptions Object
Grouping based on date DateGroupOptions Object

The only fields that may be used to group data are:

The following are defined as primitive types:

Use the GroupController.canGroupOn(IField) method to determine if a particular field can be used to group data.


Method Summary
 IField getConditionField()
           Returns which field is being used to group the data.
 int getGroupIndex()
          For internal use only.
 IGroupOptions getOptions()
           Indicates how the group behaves.
 ISort getSort()
          Gets the group sorting.
 void setConditionField(IField conditionField)
           Sets which field is being used to group the data.
 void setGroupIndex(int index)
          For internal use only.
 void setOptions(IGroupOptions options)
           Indicates how the group behaves.
 void setSort(ISort sort)
          Sets the group sorting.
 

Method Detail

getConditionField

IField getConditionField()

Returns which field is being used to group the data.

The only fields that may be used to group data are:

The following are defined as primitive types:

Use the GroupController.canGroupOn(IField) method to determine if a particular field can be used to group data.

Returns:
The field that is being used to group the data as an IField interface.

getOptions

IGroupOptions getOptions()

Indicates how the group behaves. Depending on the grouping options required, the Options property will be one of the following

Group Options Object Type
Normal group No options
Specified grouping SpecifiedGroupOptions Object
Grouping based on date DateGroupOptions Object

Returns:
The IGroupOptions interface.

setConditionField

void setConditionField(IField conditionField)

Sets which field is being used to group the data.

The only fields that may be used to group data are:

The following are defined as primitive types:

Use the GroupController.canGroupOn(IField) method to determine if a particular field can be used to group data.

Parameters:
conditionField - The field that is being used to group the data as an IField interface.

setOptions

void setOptions(IGroupOptions options)

Indicates how the group behaves. Depending on the grouping options required, the Options property will be one of the following

Group Options Object Type
Normal group No options
Specified grouping SpecifiedGroupOptions Object
Grouping based on date DateGroupOptions Object

Parameters:
options - The IGroupOptions interface.

getSort

ISort getSort()
Gets the group sorting.

Returns:
an ISort object
See Also:
GroupSortController

setSort

void setSort(ISort sort)
Sets the group sorting.

Parameters:
sort - an ISort object
See Also:
GroupSortController

getGroupIndex

int getGroupIndex()
For internal use only.


setGroupIndex

void setGroupIndex(int index)
For internal use only.