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
BucketField Constructors
BucketField Methods
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
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.

BucketField Class

Contains methods and constructors to work with information about a bucket field, including bucket type, name, and bucketed values.

Namespace

Reports

BucketField Constructors

The following are constructors for BucketField.

BucketField(bucketType, devloperName, label, nullTreatedAsZero, otherBucketLabel, sourceColumnName, values)

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

Signature

public BucketField(Reports.BucketType bucketType, String devloperName, String label, Boolean nullTreatedAsZero, String otherBucketLabel, String sourceColumnName, List<Reports.BucketFieldValue> values)

Parameters

  • bucketType:

    Type: Reports.BucketType

    The type of bucket.

  • devloperName:

    Type: String

    API

    name of the bucket.

  • label:

    Type: String

    User-facing

    name of the bucket.

  • nullTreatedAsZero:

    Type: Boolean

    Specifies whether null values are converted to zero (true) or not (false).

  • otherBucketLabel:

    Type: String

    Name of the fields grouped as Other (in buckets of BucketType PICKLIST).

  • sourceColumnName:

    Type: String

    Name of the bucketed field.

  • values:

    Type: List<Reports.BucketType>

    Types of the values included in the bucket.

BucketField()

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

Signature

public BucketField()

BucketField Methods

The following are methods for BucketField.

getBucketType()

Returns the bucket type.

Signature

public Reports.BucketType getBucketType()

Return Value

Type: Reports.BucketType

getDevloperName()

Returns the bucket’s API name.

Signature

public String getDevloperName()

Return Value

Type: String

getLabel()

Returns the user-facing name of the bucket.

Signature

public String getLabel()

Return Value

Type: String

getNullTreatedAsZero()

Returns true if null values are converted to the number zero, otherwise returns false.

Signature

public Boolean getNullTreatedAsZero()

Return Value

Type: Boolean

getOtherBucketLabel()

Returns the name of fields grouped as Other in buckets of type PICKLIST.

Signature

public String getOtherBucketLabel()

Return Value

Type: String

getSourceColumnName()

Returns the API name of the bucketed field.

Signature

public String getSourceColumnName()

Return Value

Type: String

getValues()

Returns the report values grouped by the bucket field.

Signature

public List<Reports.BucketFieldValue> getValues()

Return Value

Type: List<Reports.BucketFieldValue>

setBucketType(value)

Sets the BucketType of the bucket.

Signature

public void setBucketType(String value)

Parameters

Return Value

Type: void

setBucketType(bucketType)

Sets the BucketType of the bucket.

Signature

public void setBucketType(Reports.BucketType bucketType)

Parameters

Return Value

Type: void

setDevloperName(devloperName)

Sets the API name of the bucket.

Signature

public void setDevloperName(String devloperName)

Parameters

  • devloperName:

    Type: String

    The API name to assign to the bucket.

Return Value

Type: void

setLabel(label)

Sets the user-facing name of the bucket.

Signature

public void setLabel(String label)

Parameters

Return Value

Type: void

setNullTreatedAsZero(nullTreatedAsZero)

Specifies whether null values in the bucket are converted to zero (true) or not (false).

Signature

public void setNullTreatedAsZero(Boolean nullTreatedAsZero)

Parameters

Return Value

Type: void

setOtherBucketLabel(otherBucketLabel)

Sets the name of the fields grouped as Other (in buckets of BucketType PICKLIST).

Signature

public void setOtherBucketLabel(String otherBucketLabel)

Parameters

  • otherBucketLabel:

    Type: String

Return Value

Type: void

setSourceColumnName(sourceColumnName)

Specifies the name of the bucketed field.

Signature

public void setSourceColumnName(String sourceColumnName)

Parameters

  • sourceColumnName:

    Type: String

Return Value

Type: void

setValues(values)

Specifies which type of values are included in the bucket.

Signature

public void setValues(List<Reports.BucketFieldValue> values)

Parameters

Return Value

Type: void

toString()

Returns a string.

Signature

public String toString()

Return Value

Type: String