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

All Superinterfaces:
IClone, IGroupOptions
All Known Implementing Classes:
SpecifiedDateGroupOptions, SpecifiedGroupOptions

public interface ISpecifiedGroupOptions
extends IGroupOptions

This interface is used to get and set values for data that is grouped according to user-specified options.


Method Summary
 Filters getSpecifiedValueFilters()
          Returns the sorting criteria for the specified group.
 java.lang.String getUnspecifiedValuesName()
          Returns the name that is used to group items which do not fall under the specified grouping criteria.
 UnspecifiedValuesType getUnspecifiedValuesType()
          Indicates how records that do not fall under the specified grouping criteria are treated.
 void setSpecifiedValueFilters(Filters specifiedValueFilters)
          Stores the sorting criteria for the specified group.
 void setUnspecifiedValuesName(java.lang.String unspecifiedValuesName)
          Sets the name that is used to group items which do not fall under the specified grouping criteria.
 void setUnspecifiedValuesType(UnspecifiedValuesType unspecifiedValuesType)
          Sets how records that do not fall under the specified grouping criteria are treated.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IGroupOptions
getConditionFormulas, getHierarchicalOptions, isSortedHierarchically, setConditionFormulas, setHierarchicalOptions
 

Method Detail

getSpecifiedValueFilters

Filters getSpecifiedValueFilters()
Returns the sorting criteria for the specified group.

Returns:
A Filters object containing the sorting criteria for the specified group.

getUnspecifiedValuesName

java.lang.String getUnspecifiedValuesName()
Returns the name that is used to group items which do not fall under the specified grouping criteria. This is not a group name. More accurately, it is the name of a totaller node that is used to contain those records that do not match the specified grouping criteria. To specify this property you must set the UnspecifiedValuesType property to UnspecifiedValuesType.

Returns:
A String containing the name that is used to group items which do not fall under the specified grouping criteria.

getUnspecifiedValuesType

UnspecifiedValuesType getUnspecifiedValuesType()
Indicates how records that do not fall under the specified grouping criteria are treated. If UnspecifiedValuesType is set, the UnspecifiedValuesName property must contain the name under which extraneous records are listed.

Returns:
An UnspecifiedValuesType object that indicates how records that do not fall under the specified grouping criteria are treated.

setSpecifiedValueFilters

void setSpecifiedValueFilters(Filters specifiedValueFilters)
Stores the sorting criteria for the specified group.

Parameters:
specifiedValueFilters - A Filters object containing the sorting criteria for the specified group.

setUnspecifiedValuesName

void setUnspecifiedValuesName(java.lang.String unspecifiedValuesName)
Sets the name that is used to group items which do not fall under the specified grouping criteria. This is not a group name. More accurately, it is the name of a totaller node that is used to contain those records that do not match the specified grouping criteria. To specify this property you must set the UnspecifiedValuesType property to UnspecifiedValuesType.

Parameters:
unspecifiedValuesName - A String containing the name that is used to group items which do not fall under the specified grouping criteria.

setUnspecifiedValuesType

void setUnspecifiedValuesType(UnspecifiedValuesType unspecifiedValuesType)
Sets how records that do not fall under the specified grouping criteria are treated. If UnspecifiedValuesType is set, the UnspecifiedValuesName property must contain the name under which extraneous records are listed.

Parameters:
unspecifiedValuesType - An UnspecifiedValuesType object that indicates how records that do not fall under the specified grouping criteria are treated.