Apex Reference Guide
jNewer Version Available
FormulaBuilder Class
Namespace
Usage
For Developer Preview, all formula functions that you can include in validation rules are available to use with formulas in Apex. For details, see Formula Operators and Functions by Context.
The withType context type must be a global, user-defined Apex class. Any fields or properties that the formula references must also be global.
FormulaBuilder Methods
The following are methods for FormulaBuilder.
build()
Signature
public FormulaEval.FormulaInstance build()
Return Value
Type: FormulaEval.FormulaInstance
Returns an instance of the FormulaInstance object. If the formula validation such as field references, functions, or syntax, fails, the method throws a FormulaValidationException exception.
builder()
Signature
public static FormulaEval.FormulaBuilder builder()
Return Value
treatNumericNullAsZero(isNumericNullZero)
Signature
public FormulaEval.FormulaBuilder treatNumericNullAsZero(Boolean isNumericNullZero)
Parameters
- isNumericNullZero
- Type: Boolean
- If true, null for numeric is treated as zero. The default value is false.
Return Value
withFormula(formulaText)
Signature
public FormulaEval.FormulaBuilder withFormula(String formulaText)
Parameters
- formulaText
- Type: String
Return Value
withGlobalVariables(formulaGlobals)
Signature
public FormulaEval.FormulaBuilder withGlobalVariables(List<formulaeval.FormulaGlobal> formulaGlobals)
Parameters
- formulaGlobals
- Type: List<FormulaEval.FormulaGlobal>
- Uses values from the FormulaGlobal enum.
Return Value
withReturnType(returnType)
Signature
public FormulaEval.FormulaBuilder withReturnType(formulaeval.FormulaReturnType returnType)
Parameters
- returnType
- Type: FormulaEval.FormulaReturnType
- Uses values from the FormulaReturnType enum.
Return Value
withType(contextType)
Signature
public FormulaEval.FormulaBuilder withType(System.Type contextType)
Parameters
- contextType
- Type: System.Type
- An instance of the Apex class defined against an Apex object or SObject.