ReportTypeColumn Class

Contains detailed report type metadata about a field, including data type, display name, and filter values.

Namespace

Reports

ReportTypeColumn Methods

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

  • getDataType()
    Returns the data type of the field.
  • getFilterValues()
    If the field data type is picklist, multi-select picklist, boolean, or checkbox, returns all filter values for a field. For example, checkbox fields always have a value of true or false. For fields of other data types, the filter value is an empty array, because their values can’t be determined.
  • getFilterable()
    If the field is of a type that can’t be filtered, returns False. For example, fields of the type Encrypted Text can’t be filtered.
  • getLabel()
    Returns the localized display name of the field.
  • getName()
    Returns the unique API name of the field.

getDataType()

Returns the data type of the field.

Syntax

public Reports.ColumnDataType getDataType()

Return Value

Type: Reports.ColumnDataType

getFilterValues()

If the field data type is picklist, multi-select picklist, boolean, or checkbox, returns all filter values for a field. For example, checkbox fields always have a value of true or false. For fields of other data types, the filter value is an empty array, because their values can’t be determined.

Syntax

public LIST<Reports.FilterValue> getFilterValues()

Return Value

Type: List<Reports.FilterValue>

getFilterable()

If the field is of a type that can’t be filtered, returns False. For example, fields of the type Encrypted Text can’t be filtered.

Syntax

public Boolean getFilterable()

Return Value

Type: Boolean

getLabel()

Returns the localized display name of the field.

Syntax

public String getLabel()

Return Value

Type: String

getName()

Returns the unique API name of the field.

Syntax

public String getName()

Return Value

Type: String