Package com.smartsheet.api.models

Class ReportDefinition

java.lang.Object

com.smartsheet.api.models.ReportDefinition

public class ReportDefinition
extends java.lang.Object

The report definition contains filters, grouping and sorting properties of the report.

Note: When groupingCriteria is defined the primary column of the report will move to the index 0 when it is first rendered by the app.

Constructor Summary

Constructors

Constructor	Description
ReportDefinition()

Method Summary

Modifier and Type	Method	Description
ReportFilterExpression	getFilters()	Gets the filter expression.
java.util.List<ReportGroupingCriterion>	getGroupingCriteria()	Gets the list of report grouping criteria.
java.util.List<ReportSortingCriterion>	getSortingCriteria()	Gets the list of report sorting criteria.
java.util.List<ReportSummarizingCriterion>	getSummarizingCriteria()	Gets the list of report summarizing criteria.
ReportDefinition	setFilters(ReportFilterExpression filters)	Sets the filter expression.
ReportDefinition	setGroupingCriteria(java.util.List<ReportGroupingCriterion> groupingCriteria)	Sets the list of report grouping criteria.
ReportDefinition	setSortingCriteria(java.util.List<ReportSortingCriterion> sortingCriteria)	Sets the list of report sorting criteria.
ReportDefinition	setSummarizingCriteria(java.util.List<ReportSummarizingCriterion> summarizingCriteria)	Sets the list of report summarizing criteria.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportDefinition

public ReportDefinition()

Method Detail

getFilters

public ReportFilterExpression getFilters()

Gets the filter expression.

Returns:

the filters

setFilters

public ReportDefinition setFilters(ReportFilterExpression filters)

Sets the filter expression.

Parameters:

filters - the filter expression

getGroupingCriteria

public java.util.List<ReportGroupingCriterion> getGroupingCriteria()

Gets the list of report grouping criteria.

Returns:

the grouping criteria

setGroupingCriteria

public ReportDefinition setGroupingCriteria(java.util.List<ReportGroupingCriterion> groupingCriteria)

Sets the list of report grouping criteria.

Parameters:

groupingCriteria - the grouping criteria

getSummarizingCriteria

public java.util.List<ReportSummarizingCriterion> getSummarizingCriteria()

Gets the list of report summarizing criteria.

Returns:

the summarizing criteria

setSummarizingCriteria

public ReportDefinition setSummarizingCriteria(java.util.List<ReportSummarizingCriterion> summarizingCriteria)

Sets the list of report summarizing criteria.

Parameters:

summarizingCriteria - the summarizing criteria

getSortingCriteria

public java.util.List<ReportSortingCriterion> getSortingCriteria()

Gets the list of report sorting criteria.

Returns:

the sorting criteria

setSortingCriteria

public ReportDefinition setSortingCriteria(java.util.List<ReportSortingCriterion> sortingCriteria)

Sets the list of report sorting criteria.

Parameters:

sortingCriteria - the sorting criteria