ReportTimeframeType Class

public final class ReportTimeframeType
extends ExpandableStringEnum<ReportTimeframeType>

The time frame for pulling data for the report. If custom, then a specific time period must be provided.

Field Summary

Modifier and Type Field and Description
static final ReportTimeframeType CUSTOM

Static value Custom for ReportTimeframeType.

static final ReportTimeframeType MONTH_TO_DATE

Static value MonthToDate for ReportTimeframeType.

static final ReportTimeframeType WEEK_TO_DATE

Static value WeekToDate for ReportTimeframeType.

static final ReportTimeframeType YEAR_TO_DATE

Static value YearToDate for ReportTimeframeType.

Constructor Summary

Constructor Description
ReportTimeframeType()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of ReportTimeframeType value.

Method Summary

Modifier and Type Method and Description
static ReportTimeframeType fromString(String name)

Creates or finds a ReportTimeframeType from its string representation.

static Collection<ReportTimeframeType> values()

Gets known ReportTimeframeType values.

Methods inherited from ExpandableStringEnum

Methods inherited from java.lang.Object

Field Details

CUSTOM

public static final ReportTimeframeType CUSTOM

Static value Custom for ReportTimeframeType.

MONTH_TO_DATE

public static final ReportTimeframeType MONTH_TO_DATE

Static value MonthToDate for ReportTimeframeType.

WEEK_TO_DATE

public static final ReportTimeframeType WEEK_TO_DATE

Static value WeekToDate for ReportTimeframeType.

YEAR_TO_DATE

public static final ReportTimeframeType YEAR_TO_DATE

Static value YearToDate for ReportTimeframeType.

Constructor Details

ReportTimeframeType

@Deprecated
public ReportTimeframeType()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of ReportTimeframeType value.

Method Details

fromString

public static ReportTimeframeType fromString(String name)

Creates or finds a ReportTimeframeType from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ReportTimeframeType.

values

public static Collection values()

Gets known ReportTimeframeType values.

Returns:

known ReportTimeframeType values.

Applies to