ReportFilter Class

Contains information about a report filter, including column, operator, and value.

Namespace

Reports

ReportFilter Constructors

The following are constructors for ReportFilter.

ReportFilter()

Creates a new instance of the Reports.ReportFilter class. You can then set values by using the “set” methods.

Signature

public ReportFilter()

ReportFilter(column, operator, value)

Creates a new instance of the Reports.ReportFilter class by using the specified parameters.

Signature

public ReportFilter(String column, String operator, String value)

Parameters

column
Type: String
operator
Type: String
value
Type: String

ReportFilter(column, operator, value, filterType)

Creates a new instance of the Reports.ReportFilter class by using the specified parameters.

Syntax

public ReportFilterType(String column, String operator, String value, Reports.ReportFilterType filterType)

Parameters

column
Type: String
operator
Type: String
value
Type: String
filterType
Type: ReportFilterType Enum

ReportFilter Methods

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

getColumn()

Returns the unique API name for the field that’s being filtered.

Syntax

public String getColumn()

Return Value

Type: String

getFilterType()

Returns the type of report filter.

Syntax

public String getFilterType()

Return Value

Type: ReportFilterType Enum

getOperator()

Returns the unique API name for the condition that is used to filter a field, such as “greater than” or “not equal to.” Filter conditions depend on the data type of the field.

Syntax

public String getOperator()

Return Value

Type: String

getValue()

Returns the value that the field is being filtered by. For example, the field Age can be filtered by a numeric value.

Syntax

public String getValue()

Return Value

Type: String

setColumn(column)

Sets the unique API name for the field that’s being filtered.

Syntax

public Void setColumn(String column)

Parameters

column
Type: String

Return Value

Type: Void

setFilterType()

Sets the type of report filter.

Syntax

public Void setFilterType(String column)

Parameters

column
Type: String

Return Value

Type: Void

setOperator(operator)

Sets the unique API name for the condition that is used to filter a field, such as “greater than” or “not equal to.” Filter conditions depend on the data type of the field.

Syntax

public Void setOperator(String operator)

Parameters

operator
Type: String

Return Value

Type: Void

setValue(value)

Sets the value by which a field can be filtered. For example, the field Age can be filtered by a numeric value.

Syntax

public Void setValue(String value)

Parameters

value
Type: String

Return Value

Type: Void

toString(column)

Returns a string representation of the filter.

Signature

public String toString()

Return Value

Type: String