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

All Superinterfaces:
IClone, IField
All Known Subinterfaces:
ISummaryField
All Known Implementing Classes:
SummaryField

public interface ISummaryFieldBase
extends IField

This interface defines the basic operations for summary fields.


Method Summary
 SummaryOperation getOperation()
          Returns the manner in which the summary will be calculated.
 int getOperationParameter()
          Gets the operation parameter.
 IField getSecondarySummarizedField()
          Gets the secondary summarized field.
 IField getSummarizedField()
          Returns the field that is being used to calculate the summary.
 void setOperation(SummaryOperation operation)
          Sets the manner in which the summary will be calculated.
 void setOperationParameter(int parameter)
          Sets the operation parameter.
 void setSecondarySummarizedField(IField summarizedField)
          Sets the secondary summarized field.
 void setSummarizedField(IField summarizedField)
          Sets the field that is being used to calculate the summary.
 
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

getOperation

SummaryOperation getOperation()
Returns the manner in which the summary will be calculated.

Returns:
A SummaryOperation object that specifies the manner in which the summary will be calculated.

getSummarizedField

IField getSummarizedField()
Returns the field that is being used to calculate the summary.

Returns:
An IField object containing the field that is being used to calculate the summary.

setOperation

void setOperation(SummaryOperation operation)
Sets the manner in which the summary will be calculated.

Parameters:
operation - A SummaryOperation object that specifies the manner in which the summary will be calculated.

setSummarizedField

void setSummarizedField(IField summarizedField)
Sets the field that is being used to calculate the summary.

Parameters:
summarizedField - An IField object containing the field that is being used to calculate the summary.

getOperationParameter

int getOperationParameter()
Gets the operation parameter. Most SummaryOperation types do not need a parameter, however, some summary operations (i.e., "Nth Largest, N is") require an integer parameter.

Returns:
an int parameter for the SummaryOperation
See Also:
getOperation()

setOperationParameter

void setOperationParameter(int parameter)
Sets the operation parameter. Most SummaryOperation types do not need a parameter, however, some summary operations (i.e., "Nth Largest, N is") require an integer parameter.

Parameters:
parameter - the int parameter used by the SummaryOperation
See Also:
setOperation(SummaryOperation)

getSecondarySummarizedField

IField getSecondarySummarizedField()
Gets the secondary summarized field.

Returns:
the secondary summarized field

setSecondarySummarizedField

void setSecondarySummarizedField(IField summarizedField)
Sets the secondary summarized field.

Parameters:
summarizedField - the secondary summarized field