Package com.smartsheet.api.models

Interface ReportFilterObjectValue

All Known Implementing Classes:

CurrentUserObjectValue, DateObjectValue, NumberObjectValue, StringObjectValue

public interface ReportFilterObjectValue

Marker interface for filter values used in ReportFilterCriterion.

This interface extends ObjectValue and provides type safety for report filter values. Implementations include:

• StringObjectValue - for string values
• NumberObjectValue - for numeric values
• DateObjectValue - for date values
• CurrentUserObjectValue - for current user filters

Static factory methods provide convenient ways to create filter values:

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

Method Summary

Static Methods

Modifier and Type	Method	Description
static ReportFilterObjectValue	currentUser()	Creates a CURRENT_USER filter value.
static ReportFilterObjectValue	date(java.lang.String value)	Creates a date filter value with DATE objectType.
static ReportFilterObjectValue	date(java.util.Date date)	Creates a date filter value from a Java Date object.
static ReportFilterObjectValue	number(java.lang.Number value)	Creates a numeric filter value.
static ReportFilterObjectValue	string(java.lang.String value)	Creates a string filter value.

Method Detail

string

static ReportFilterObjectValue string(java.lang.String value)

Creates a string filter value.

Parameters:

value - the string value

Returns:

a StringObjectValue implementing ReportFilterObjectValue

number

static ReportFilterObjectValue number(java.lang.Number value)

Creates a numeric filter value.

Parameters:

value - the numeric value

Returns:

a NumberObjectValue implementing ReportFilterObjectValue

date

static ReportFilterObjectValue date(java.lang.String value)

Creates a date filter value with DATE objectType.

The value should be in ISO 8601 format: "yyyy-MM-dd"

Parameters:

value - the date string in "yyyy-MM-dd" format

Returns:

a DateObjectValue with DATE objectType implementing ReportFilterObjectValue

date

static ReportFilterObjectValue date(java.util.Date date)

Creates a date filter value from a Java Date object.

Parameters:

date - the Date object

Returns:

a DateObjectValue with DATE objectType implementing ReportFilterObjectValue

currentUser

static ReportFilterObjectValue currentUser()

Creates a CURRENT_USER filter value.

This represents a special filter value that matches the current authenticated user. The value is typically empty or set to a placeholder as the server interprets this based on the objectType.

Returns:

a CurrentUserObjectValue implementing ReportFilterObjectValue