Apex Reference Guide

Apex Reference Guide
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
DataWeave Namespace (Developer Preview)
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Functions Namespace
Invocable Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
AggregateColumn Class
BucketField Class
BucketFieldValue Class
BucketType Enum
ColumnDataType Enum
ColumnSortOrder Enum
CrossFilter Class
CrossFilter Constructors
CrossFilter Methods
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
RichMessaging Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
sfdc_surveys Namespace
Site 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

CrossFilter Class

Contains methods and constructors used to work with information about a cross filter.

Namespace

Reports

CrossFilter Constructors

The following are constructors for CrossFilter.

CrossFilter(criteria, includesObject, primaryEntityField, relatedEntity, relatedEntityJoinField)

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

Signature

public CrossFilter(List<Reports.ReportFilter> criteria, Boolean includesObject, String primaryEntityField, String relatedEntity, String relatedEntityJoinField)

Parameters

criteria
Type: List<Reports.ReportFilter>
Information about how to filter the relatedEntity. Relates the primary entity with a subset of the relatedEntity.
includesObject
Type: Boolean
Specifies whether objects returned have a relationship with the relatedEntity (true) or not (false).
primaryEntityField
Type: String
The name of the object on which the cross filter is evaluated.
relatedEntity
Type: String
The name of the object that the primaryEntityField is evaluated against—the right-hand side of the cross filter.
relatedEntityJoinField
Type: String
The name of the field used to join the primaryEntityField and relatedEntity.

CrossFilter()

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

Signature

public CrossFilter()

CrossFilter Methods

The following are methods for CrossFilter.

getCriteria()

Returns information about how to filter the relatedEntity. Describes the subset of the relatedEntity which the primary entity is evaluated against.

Signature

public List<Reports.ReportFilter> getCriteria()

Return Value

Type: List<Reports.ReportFilter>

getIncludesObject()

Returns true if primary object has a relationship with the relatedEntity, otherwise returns false.

Signature

public Boolean getIncludesObject()

Return Value

Type: Boolean

getPrimaryEntityField()

Returns the name of the object on which the cross filter is evaluated.

Signature

public String getPrimaryEntityField()

Return Value

Type: String

getRelatedEntity()

Returns name of the object that the primaryEntityField is evaluated against—the right-hand side of the cross filter.

Signature

public String getRelatedEntity()

Return Value

Type: String

getRelatedEntityJoinField()

Returns the name of the field used to join the primaryEntityField and relatedEntity.

Signature

public String getRelatedEntityJoinField()

Return Value

Type: String

setCriteria(criteria)

Specifis how to filter the relatedEntity. Relates the primary entity with a subset of the relatedEntity.

Signature

public void setCriteria(List<Reports.ReportFilter> criteria)

Parameters

criteria
Type: List<Reports.ReportFilter>

Return Value

Type: void

setIncludesObject(includesObject)

Specifies whether objects returned have a relationship with the relatedEntity (true) or not (false).

Signature

public void setIncludesObject(Boolean includesObject)

Parameters

includesObject
Type: Boolean

Return Value

Type: void

setPrimaryEntityField(primaryEntityField)

Specifies the name of the object on which the cross filter is evaluated.

Signature

public void setPrimaryEntityField(String primaryEntityField)

Parameters

primaryEntityField
Type: String

Return Value

Type: void

setRelatedEntity(relatedEntity)

Specifies the name of the object that the primaryEntityField is evaluated against—the right-hand side of the cross filter.

Signature

public void setRelatedEntity(String relatedEntity)

Parameters

relatedEntity
Type: String

Return Value

Type: void

setRelatedEntityJoinField(relatedEntityJoinField)

Specifies the name of the field used to join the primaryEntityField and relatedEntity.

Signature

public void setRelatedEntityJoinField(String relatedEntityJoinField)

Parameters

relatedEntityJoinField
Type: String

Return Value

Type: void

toString()

Returns a string.

Signature

public String toString()

Return Value

Type: String