ReportResults Class

Contains the results of running a report.

Namespace

Reports

ReportResults Methods

The following are methods for ReportResults. All are instance methods.

  • getAllData()
    Returns all report data.
  • getFactMap()
    Returns summary-level data or summary and detailed data for each row or column grouping. Detailed data is available if the includeDetails parameter is set to true when the report is run.
  • getGroupingsAcross()
    Returns a collection of column groupings, keys, and values.
  • getGroupingsDown()
    Returns a collection of row groupings, keys, and values.
  • getHasDetailRows()
    Returns information about whether the fact map has detail rows.
  • getReportExtendedMetadata()
    Returns additional, detailed metadata about the report, including data type and label information for groupings and summaries.
  • getReportMetadata()
    Returns metadata about the report, including grouping and summary information.

getAllData()

Returns all report data.

Syntax

public Boolean getAllData()

Return Value

Type: Boolean

Usage

When true, indicates that all report results are returned.

When false, indicates that results are returned for the same number of rows as in a report run in Salesforce.

Note

Note

For reports that contain too many records, use filters to refine results.

getFactMap()

Returns summary-level data or summary and detailed data for each row or column grouping. Detailed data is available if the includeDetails parameter is set to true when the report is run.

Syntax

public MAP<String,Reports.ReportFact> getFactMap()

Return Value

Type: Map<String,Reports.ReportFact>

getGroupingsAcross()

Returns a collection of column groupings, keys, and values.

Syntax

public Reports.Dimension getGroupingsAcross()

Return Value

Type: Reports.Dimension

getGroupingsDown()

Returns a collection of row groupings, keys, and values.

Syntax

public Reports.Dimension getGroupingsDown()

Return Value

Type: Reports.Dimension

getHasDetailRows()

Returns information about whether the fact map has detail rows.

Syntax

public Boolean getHasDetailRows()

Return Value

Type: Boolean

Usage

  • When true, indicates that the fact map returns values for summary-level and record-level data.
  • When false, indicates that the fact map returns summary values.

getReportExtendedMetadata()

Returns additional, detailed metadata about the report, including data type and label information for groupings and summaries.

Syntax

public Reports.ReportExtendedMetadata getReportExtendedMetadata()

Return Value

Type: Reports.ReportExtendedMetadata

getReportMetadata()

Returns metadata about the report, including grouping and summary information.

Syntax

public Reports.ReportMetadata getReportMetadata()

Return Value

Type: Reports.ReportMetadata