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
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
Compression Namespace (Developer Preview)
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
FormulaEval Namespace (Developer Preview)
FormulaBuilder Class
FormulaGlobal Enum
FormulaInstance Class
FormulaInstance Methods
FormulaReturnType Enum
Functions Namespace
Invocable Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RichMessaging Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout 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

FormulaInstance Class

Contains a method to evaluate the formula instance.

Namespace

FormulaEval

Example

1global class MotorYacht {
2   global Integer lengthInYards;
3   global Integer numOfGuestCabins;
4   global String name;
5   global Account owner;
6}
7
8MotorYacht aBoat = new MotorYacht();
9aBoat.lengthInYards = 52; 
10aBoat.numOfGuestCabins = 4;
11aBoat.name = 'RV Foo';
12FormulaEval.FormulaInstance isItSuper = FormulaEval.FormulaBuilder.builder()
13                            .withReturnType(FormulaEval.FormulaReturnType.STRING)
14                            .withType(MotorYacht.class)
15                            .withFormula('IF(lengthInYards < 100, "Not Super", "Super")')
16                            .build();
17isItSuper.evaluate(aBoat); //=> "Not Super"
18
19aBoat.owner = new Account(Name='Acme Watercraft', Site='New York');
20FormulaEval.FormulaInstance ownerDetails = FormulaEval.FormulaBuilder.builder()
21                            .withReturnType(FormulaEval.FormulaReturnType.STRING)
22                            .withType(MotorYacht.class)
23                            .withFormula('owner.Name & " (" & owner.Site & ")"')
24                            .build();
25ownerDetails.evaluate(aBoat); //=> "Acme Watercraft (New York)"
26

Usage

The withType context type must be a global, user-defined Apex class. Any fields or properties that the formula references must also be global.

FormulaInstance Methods

The following are methods for FormulaInstance.

evaluate(contextObject)

Calculates the formula expression and returns the formula output.

Signature

public Object evaluate(Object contextObject)

Parameters

contextObject
Type: Object
An instance of the Apex class as generated with the FormulaBuilder.builder() method.

Return Value

Type: Object

Apex type that corresponds to the Apex class as configured by the withType() method in the FormulaBuilder class.