CommonReturnValue (JasperReports Library 6.20.2 API)

All Superinterfaces:

Cloneable, JRCloneable

All Known Subinterfaces:

ExpressionReturnValue, JRSubreportReturnValue, ReturnValue, VariableReturnValue

All Known Implementing Classes:

BaseCommonReturnValue, BaseExpressionReturnValue, BaseReturnValue, DesignCommonReturnValue, DesignExpressionReturnValue, DesignReturnValue, JRBaseSubreportReturnValue, JRDesignSubreportReturnValue, JRFillCommonReturnValue, JRFillExpressionReturnValue, JRFillVariableReturnValue, SubreportReturnValueAdapter
```
public interface CommonReturnValue
extends JRCloneable
```
A value copied from a subdataset or from an expression into a variable of the parent report.

Author:

Lucian Chirita ([email protected])

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`CalculationEnum`	`getCalculation()`	Returns the calculation type.
`String`	`getIncrementerFactoryClassName()`	Returns the incrementer factory class name.
`String`	`getToVariable()`	Returns the name of the report variable where the value should be copied.

Methods inherited from interface net.sf.jasperreports.engine.JRCloneable
clone

- Method Detail
  - getToVariable
```
String getToVariable()
```
    Returns the name of the report variable where the value should be copied.
    
    Returns:
    
    the name of the report variable where the value should be copied.
  - getCalculation
```
CalculationEnum getCalculation()
```
    Returns the calculation type.
    When copying the value from, a formula can be applied such that sum, maximum, average and so on can be computed.
    
    Returns:
    
    the calculation type.
  - getIncrementerFactoryClassName
```
String getIncrementerFactoryClassName()
```
    Returns the incrementer factory class name.
    The factory will be used to increment the value of the report variable with the returned value.
    
    Returns:
    
    the incrementer factory class name.