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

All Superinterfaces:
IClone, IField, ISummaryFieldBase
All Known Implementing Classes:
SummaryField

public interface ISummaryField
extends ISummaryFieldBase

This interface is used to modify a summary for a group, or for the entire report.


Method Summary
 IGroup getGroup()
          Returns the group for which the summary is being calculated.
 IGroup getSecondGroupForPercentage()
          Gets the group that is used for the percentage summary.
 boolean isPercentageSummary()
          Gets whether the summary calculates the percentage total of one group within a broader grouping.
 boolean isSummarizedAcrossHierarchy()
          Gets whether the summary is calculated across hierarchical groupings.
 void setGroup(IGroup group)
          Sets the group for which the summary is being calculated.
 void setPercentageSummary(boolean percentageSummary)
          Sets whether the summary calculates the percentage total of one group within a broader grouping.
 void setSecondGroupForPercentage(IGroup group)
          Sets the group that is used for the percentage summary.
 void setSummarizedAcrossHierarchy(boolean sumAcrossHierarchy)
          Sets whether the summary is calculated across hierarchical groupings.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.ISummaryFieldBase
getOperation, getOperationParameter, getSecondarySummarizedField, getSummarizedField, setOperation, setOperationParameter, setSecondarySummarizedField, setSummarizedField
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IField
getDescription, getDisplayName, getFormulaForm, getHeadingText, getIsRecurring, getKind, getLength, getLongName, getName, getShortName, getType, setDescription, setHeadingText, setLength, setName, setType
 

Method Detail

getGroup

IGroup getGroup()
Returns the group for which the summary is being calculated.

Returns:
An IGroup object containing the group for which the summary field is being calculated.

setGroup

void setGroup(IGroup group)
Sets the group for which the summary is being calculated.

Parameters:
group - An IGroup object containing the group for which the summary field is being calculated.

getSecondGroupForPercentage

IGroup getSecondGroupForPercentage()
Gets the group that is used for the percentage summary.

Returns:
the IGroup used for the percentage summary
See Also:
isPercentageSummary()

setSecondGroupForPercentage

void setSecondGroupForPercentage(IGroup group)
Sets the group that is used for the percentage summary.

Parameters:
group - the IGroup to use for the percentage summary
See Also:
setPercentageSummary(boolean)

isPercentageSummary

boolean isPercentageSummary()
Gets whether the summary calculates the percentage total of one group within a broader grouping. For example, you can show the percentage of sales in each city based on the total sales for each country.

Note: The percentage option is valid only when the result of a summary operation is numeric.

Returns:
true if the percentage summary is enabled, false if it is disabled
See Also:
getSecondGroupForPercentage()

setPercentageSummary

void setPercentageSummary(boolean percentageSummary)
Sets whether the summary calculates the percentage total of one group within a broader grouping. For example, you can show the percentage of sales in each city based on the total sales for each country.

Parameters:
percentageSummary - true to enable percentage summary, false to disable it
See Also:
setSecondGroupForPercentage(IGroup)

isSummarizedAcrossHierarchy

boolean isSummarizedAcrossHierarchy()
Gets whether the summary is calculated across hierarchical groupings.

Returns:
true if the summary is calculated across hierarchical groupings, false if it is not

setSummarizedAcrossHierarchy

void setSummarizedAcrossHierarchy(boolean sumAcrossHierarchy)
Sets whether the summary is calculated across hierarchical groupings.

Parameters:
sumAcrossHierarchy - true to enable calculating the summary across hierarchical groupings, false to disable it