Package com.smartsheet.api.models

Class ReportFilterCriterion

java.lang.Object

com.smartsheet.api.models.ReportFilterCriterion

public class ReportFilterCriterion
extends java.lang.Object

Represents a single filter criterion.

Constructor Summary

Constructors

Constructor	Description
ReportFilterCriterion()

Method Summary

Modifier and Type	Method	Description
ReportColumnIdentifier	getColumn()	Gets the column identifier.
ReportFilterOperator	getOperator()	Gets the condition operator.
java.util.List<ReportFilterObjectValue>	getValues()	Gets the filter values.
ReportFilterCriterion	setColumn(ReportColumnIdentifier column)	Sets the column identifier.
ReportFilterCriterion	setOperator(ReportFilterOperator operator)	Sets the condition operator.
ReportFilterCriterion	setValues(java.util.List<ReportFilterObjectValue> values)	Sets the filter values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportFilterCriterion

public ReportFilterCriterion()

Method Detail

getColumn

public ReportColumnIdentifier getColumn()

Gets the column identifier.

Returns:

the column

setColumn

public ReportFilterCriterion setColumn(ReportColumnIdentifier column)

Sets the column identifier.

Parameters:

column - the column

getOperator

public ReportFilterOperator getOperator()

Gets the condition operator.

Returns:

the operator

setOperator

public ReportFilterCriterion setOperator(ReportFilterOperator operator)

Sets the condition operator.

Parameters:

operator - the operator

getValues

public java.util.List<ReportFilterObjectValue> getValues()

Gets the filter values.

Values are ReportFilterObjectValue implementations representing different types:

• StringObjectValue - string values
• NumberObjectValue - numeric values
• DateObjectValue - date values with objectType
• CurrentUserObjectValue - current user filters
• null - for null/empty values

Returns:

the values

setValues

public ReportFilterCriterion setValues(java.util.List<ReportFilterObjectValue> values)

Sets the filter values.

Values should be ReportFilterObjectValue implementations. Use the static factory methods for type-safe value creation:

• ReportFilterObjectValue.string(String) - for string values
• ReportFilterObjectValue.number(Number) - for numeric values
• ReportFilterObjectValue.date(String) or ReportFilterObjectValue.date(java.util.Date) - for date values
• ReportFilterObjectValue.currentUser() - for current user filters

Example usage:

 criterion.setValues(Arrays.asList(
     ReportFilterObjectValue.string("value1"),
     ReportFilterObjectValue.number(42),
     ReportFilterObjectValue.date("2024-01-01"),
     ReportFilterObjectValue.currentUser()
 ));
 

Parameters:

values - the values