com.smartsheet.api.models

Class Report

java.lang.Object

com.smartsheet.api.models.IdentifiableModel<T>

com.smartsheet.api.models.NamedModel<Long>

com.smartsheet.api.models.AbstractSheet<ReportRow,ReportColumn,ReportCell>

com.smartsheet.api.models.Report

public class Report
extends AbstractSheet<ReportRow,ReportColumn,ReportCell>

A report object that is a filtered view of the data from one or more Sheets.

See Also:

Creating Reports Help

Constructor Summary

Constructors

Constructor and Description
Report()

Method Summary

Modifier and Type	Method and Description
Scope	getScope() Gets the scope of the report
List<Sheet>	getSourceSheets() Gets the sheet array.
Report	setScope(Scope scope) Sets the scope of the report
Report	setSourceSheets(List<Sheet> sourceSheets) Sets the sheet array.

Methods inherited from class com.smartsheet.api.models.AbstractSheet

getAccessLevel, getAttachments, getColumnById, getColumnByIndex, getColumns, getContactReferences, getCreatedAt, getCrossSheetReferences, getDependenciesEnabled, getDiscussions, getEffectiveAttachmentOptions, getFilters, getFromId, getGanttEnabled, getHasSummaryFields, getModifiedAt, getOwner, getOwnerId, getPermalink, getProjectSettings, getReadOnly, getResourceManagementEnabled, getRowByRowNumber, getRows, getShowParentRowsForFilters, getSource, getSummary, getTotalRowCount, getUserPermissions, getUserSettings, getVersion, getWorkspace, isFavorite, setAccessLevel, setAttachments, setColumns, setContactReferences, setCreatedAt, setCrossSheetReferences, setDependenciesEnabled, setDiscussions, setEffectiveAttachmentOptions, setFavorite, setFilters, setFromId, setGanttEnabled, setHasSummaryFields, setModifiedAt, setName, setOwner, setOwnerId, setPermalink, setProjectSettings, setReadOnly, setResourceManagementEnabled, setRows, setShowParentRowsForFilters, setSource, setSummary, setTotalRowCount, setUserPermissions, setUserSettings, setVersion, setWorkspace

Methods inherited from class com.smartsheet.api.models.NamedModel

getName

Methods inherited from class com.smartsheet.api.models.IdentifiableModel

equals, getId, hashCode, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

Report

public Report()

Method Detail

getScope

public Scope getScope()

Gets the scope of the report

Returns:

the scope

setScope

public Report setScope(Scope scope)

Sets the scope of the report

Parameters:

scope -

getSourceSheets

public List<Sheet> getSourceSheets()

Gets the sheet array.

Returns:

the sourceSheets

setSourceSheets

public Report setSourceSheets(List<Sheet> sourceSheets)

Sets the sheet array.

Parameters:

sourceSheets - the new index