GroupingInfo Class

Contains methods for describing fields that are used for grouping.

Namespace

Reports

GroupingInfo Methods

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

  • getName()
    Returns the unique API name of the field or bucket field that is used for row or column grouping.
  • getSortOrder()
    Returns the order that is used to sort data in a row or column grouping (ASCENDING or DESCENDING).
  • getDateGranularity()
    Returns the date interval that is used for row or column grouping.
  • getSortAggregate()
    Returns the summary field that is used to sort data within a grouping in a summary report. The value is null when data within a grouping is not sorted by a summary field.

getName()

Returns the unique API name of the field or bucket field that is used for row or column grouping.

Syntax

public String getName()

Return Value

Type: String

getSortOrder()

Returns the order that is used to sort data in a row or column grouping (ASCENDING or DESCENDING).

Syntax

public Reports.ColumnSortOrder getSortOrder()

Return Value

Type: Reports.ColumnSortOrder

getDateGranularity()

Returns the date interval that is used for row or column grouping.

Syntax

public Reports.DateGranularity getDateGranularity()

Return Value

Type: Reports.DateGranularity

getSortAggregate()

Returns the summary field that is used to sort data within a grouping in a summary report. The value is null when data within a grouping is not sorted by a summary field.

Syntax

public String getSortAggregate()

Return Value

Type: String