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
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
commonserviceexcellence Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
disputemanagement Namespace
fsccashflow Namespace
fsccomplaintmanagement Namespace
fschousehold Namespace
fscserviceprocesses Namespace
fscwmgen Namespace
industriespersonalizedfinance Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
AggregateColumn Class
BucketField Class
BucketFieldValue Class
BucketType Enum
ColumnDataType Enum
ColumnSortOrder Enum
CrossFilter Class
CsfGroupType Enum
DateGranularity Enum
DetailColumn Class
Dimension Class
EvaluatedCondition Class
EvaluatedConditionOperator Enum
FilterOperator Class
FilterValue Class
FormulaType Enum
GroupingColumn Class
GroupingInfo Class
GroupingValue Class
NotificationAction Interface
NotificationActionContext Class
ReportCsf Class
ReportCsf Constructors
ReportCsf Methods
ReportCurrency Class
ReportDataCell Class
ReportDescribeResult Class
ReportDetailRow Class
ReportDivisionInfo Class
ReportExtendedMetadata Class
ReportFact Class
ReportFactWithDetails Class
ReportFactWithSummaries Class
ReportFilter Class
ReportFormat Enum
ReportFilterType Enum
ReportInstance Class
ReportManager Class
ReportMetadata Class
ReportResults Class
ReportScopeInfo Class
ReportScopeValue Class
ReportType Class
ReportTypeColumn Class
ReportTypeColumnCategory Class
ReportTypeMetadata Class
SortColumn Class
StandardDateFilter Class
StandardDateFilterDuration Class
StandardDateFilterDurationGroup Class
StandardFilter Class
StandardFilterInfo Class
StandardFilterInfoPicklist Class
StandardFilterType Enum
SummaryValue Class
ThresholdInformation Class
TopRows Class
Reports Exceptions
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

ReportCsf Class

Contains methods and constructors for working with information about a custom summary formula (CSF).

Namespace

Reports

ReportCsf Constructors

The following are constructors for ReportCsf.

ReportCsf(label, description, formulaType, decimalPlaces, downGroup, downGroupType, acrossGroup, acrossGroupType, formula)

Creates an instance of the Reports.ReportCsf class using the specified parameters.

Signature

public ReportCsf(String label, String description, Reports.FormulaType formulaType, Integer decimalPlaces, String downGroup, Reports.CsfGroupType downGroupType, String acrossGroup, Reports.CsfGroupType acrossGroupType, String formula)

Parameters

  • label:

    Type: String

    The user-facing name of the custom summary formula.

  • description:

    Type: String

    The user-facing description of the custom summary formula.

  • formulaType:

    Type: Reports.FormulaType

    The format of the numbers in the custom summary formula.

  • decimalPlaces:

    Type: Integer

    The number of decimal places to include in numbers.

  • downGroup:

    Type: String

    The name of a row grouping when the downGroupType is CUSTOM; null otherwise.

  • downGroupType:

    Type: Reports.CsfGroupType

    Where to display

    the aggregate of the custom summary formula.

  • acrossGroup:

    Type: String

    The name of a column grouping when the accrossGroupType is CUSTOM; null otherwise.

  • acrossGroupType:

    Type: Reports.CsfGroupType

    Where to display

    the aggregate of the custom summary formula.

  • formula:

    Type: String

    The operations performed on values in the custom summary formula.

ReportCsf()

Creates an instance of the Reports.ReportCsf class. You can then set values by using the class’s set methods.

Signature

public ReportCsf()

ReportCsf Methods

The following are methods for ReportCsf.

getAcrossGroup()

Returns the name of a column grouping when the acrossGroupType is CUSTOM. Otherwise, returns null.

Signature

public String getAcrossGroup()

Return Value

Type: String

getAcrossGroupType()

Returns where to display the aggregate.

Signature

public Reports.CsfGroupType getAcrossGroupType()

Return Value

Type: Reports.CsfGroupType

getDecimalPlaces()

Returns the number of decimal places that numbers in the custom summary formula have.

Signature

public Integer getDecimalPlaces()

Return Value

Type: Integer

getDescription()

Returns the user-facing description of a custom summary formula.

Signature

public String getDescription()

Return Value

Type: String

getDownGroup()

Returns the name of a row grouping when the downGroupType is CUSTOM. Otherwise, returns null.

Signature

public String getDownGroup()

Return Value

Type: String

getDownGroupType()

Returns where to display the aggregate of the custom summary formula.

Signature

public Reports.CsfGroupType getDownGroupType()

Return Value

Type: Reports.CsfGroupType

getFormula()

Returns the operations performed on values in the custom summary formula.

Signature

public String getFormula()

Return Value

Type: String

getFormulaType()

Returns the formula type.

Signature

public Reports.FormulaType getFormulaType()

Return Value

Type: Reports.FormulaType

getLabel()

Returns the user-facing name of the custom summary formula.

Signature

public String getLabel()

Return Value

Type: String

setAcrossGroup(acrossGroup)

Specifies the column for the across grouping.

Signature

public void setAcrossGroup(String acrossGroup)

Parameters

Return Value

Type: void

setAcrossGroupType(value)

Sets where to display the aggregate.

Signature

public void setAcrossGroupType(String value)

Parameters

Return Value

Type: void

setAcrossGroupType(acrossGroupType)

Sets where to display the aggregate.

Signature

public void setAcrossGroupType(Reports.CsfGroupType acrossGroupType)

Parameters

Return Value

Type: void

setDecimalPlaces(decimalPlaces)

Sets the number of decimal places in numbers.

Signature

public void setDecimalPlaces(Integer decimalPlaces)

Parameters

Return Value

Type: void

setDescription(description)

Sets the user-facing description of the custom summary formula.

Signature

public void setDescription(String description)

Parameters

Return Value

Type: void

setDownGroup(downGroup)

Sets the name of a row grouping when the downGroupType is CUSTOM.

Signature

public void setDownGroup(String downGroup)

Parameters

Return Value

Type: void

setDownGroupType(value)

Sets where to display the aggregate.

Signature

public void setDownGroupType(String value)

Parameters

Return Value

Type: void

setDownGroupType(downGroupType)

Sets where to display the aggregate.

Signature

public void setDownGroupType(Reports.CsfGroupType downGroupType)

Parameters

Return Value

Type: void

setFormula(formula)

Sets the operations to perform on values in the custom summary formula.

Signature

public void setFormula(String formula)

Parameters

Return Value

Type: void

setFormulaType(value)

Sets the format of the numbers in the custom summary formula.

Signature

public void setFormulaType(String value)

Parameters

Return Value

Type: void

setFormulaType(formulaType)

Sets the format of numbers used in the custom summary formula.

Signature

public void setFormulaType(Reports.FormulaType formulaType)

Parameters

Return Value

Type: void

setLabel(label)

Sets the user-facing name of the custom summary formula.

Signature

public void setLabel(String label)

Parameters

Return Value

Type: void

toString()

Returns a string.

Signature

public String toString()

Return Value

Type: String