Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
FormulaEval Namespace
FormulaBuilder Class
FormulaBuilder Methods
FormulaGlobal Enum
FormulaInstance Class
FormulaReturnType Enum
fsccashflow Namespace
Functions Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
Salesforce_Backup Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

FormulaBuilder Class

Contains methods to build and validate user-defined formulas.

Namespace

FormulaEval

Usage

The context type that corresponds to the Apex class used in the builder withType() method 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()

Validates and returns the formula instance created using the FormulaBuilder methods.

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.

treatNumericNullAsZero(isNumericNullZero)

Optional. Indicates whether a null for a numeric data type is treated as zero while evaluating the formula with the build() method.

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

Type: FormulaEval.FormulaBuilder

withFormula(formulaText)

Required. Sets the formula expression that the build() method uses to create the formula instance.

Signature

public FormulaEval.FormulaBuilder withFormula(String formulaText)

Parameters

formulaText
Type: String

Return Value

Type: FormulaEval.FormulaBuilder

withGlobalVariables(formulaGlobals)

Optional. Sets the list of global variables that can be referenced in the formula expression created with the build() method.

Signature

public FormulaEval.FormulaBuilder withGlobalVariables(List<formulaeval.FormulaGlobal> formulaGlobals)

Parameters

formulaGlobals
Type: List<FormulaEval.FormulaGlobal>
Uses values from the FormulaGlobal enum.

Return Value

Type: FormulaEval.FormulaBuilder

withReturnType(returnType)

Required. Sets the formula output data type for the formula instance created with the build() method.

Signature

public FormulaEval.FormulaBuilder withReturnType(formulaeval.FormulaReturnType returnType)

Parameters

returnType
Type: FormulaEval.FormulaReturnType
Uses values from the FormulaReturnType enum.

Return Value

Type: FormulaEval.FormulaBuilder

withType(contextType)

Sets the Apex type that corresponds to the Apex class used with the build() method.

Signature

public formulaeval.FormulaBuilder withType(System.Type contextType)

Parameters

contextType
Type: System.Type
An instance of the Apex class type.

Return Value

Type: FormulaEval.FormulaBuilder

withType(contextType)

Sets the Apex type that corresponds to the Apex class used with the build() method to SObject type.

Signature

public formulaeval.FormulaBuilder withType(Schema.SObjectType contextSObjectType)

Parameters

contextSObjectType
Type: Schema.SObjectType
An instance of the SObject type.

Return Value

Type: FormulaEval.FormulaBuilder

Example

This example uses an SObject type as an input in the withType() method to build and evaluate a formula.
1FormulaEval.FormulaInstance ff = Formula.builder()
2    .withReturnType(FormulaEval.FormulaReturnType.Boolean)
3    .withType(Account.SObjectType)
4    .withFormula('ISBLANK(Site)')
5    .build();
6
7Boolean siteIsBlank = (Boolean)ff.evaluate(new Account(Site='Test'));
8Assert.isFalse(siteIsBlank);