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

All Superinterfaces:
IField
All Known Implementing Classes:
FormulaField

public interface IFormulaField
extends IField

This interface defines a formula field in the report.


Method Summary
 FormulaNullTreatment getFormulaNullTreatment()
           Gets a value that specifies how to deal with NULL values at runtime.
 int getOptions()
          For internal use only.
 FormulaSyntax getSyntax()
          Returns the syntax used to write the formula.
 java.lang.String getText()
          Returns the formula string.
 void setFormulaNullTreatment(FormulaNullTreatment treatment)
           Sets a value that specifies how to deal with NULL values at runtime.
 void setOptions(int options)
          For internal use only.
 void setSyntax(FormulaSyntax syntax)
          Sets the syntax used to write the formula.
 void setText(java.lang.String text)
          Sets the formula string.
 
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

getOptions

public int getOptions()

For internal use only.


getSyntax

public FormulaSyntax getSyntax()

Returns the syntax used to write the formula.

Returns:
The FormulaSyntax object.

getText

public java.lang.String getText()

Returns the formula string.

Returns:
The formula as a String.

getFormulaNullTreatment

public FormulaNullTreatment getFormulaNullTreatment()

Gets a value that specifies how to deal with NULL values at runtime.

Returns:
a FormulaNullTreatment object that specifies how to deal with NULL values at runtime

setOptions

public void setOptions(int options)

For internal use only.


setSyntax

public void setSyntax(FormulaSyntax syntax)

Sets the syntax used to write the formula.

Parameters:
syntax - the FormulaSyntax object

setText

public void setText(java.lang.String text)

Sets the formula string.

Parameters:
text - the formula as a String

setFormulaNullTreatment

public void setFormulaNullTreatment(FormulaNullTreatment treatment)

Sets a value that specifies how to deal with NULL values at runtime.

Parameters:
treatment - a FormulaNullTreatment object that specifies how to deal with NULL values at runtime.