com.smartsheet.api.models

Class AbstractSheet<TRow extends AbstractRow<TColumn,TCell>,TColumn extends Column,TCell extends Cell>

java.lang.Object

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

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

com.smartsheet.api.models.AbstractSheet<TRow,TColumn,TCell>

Direct Known Subclasses:

Report, Sheet

public class AbstractSheet<TRow extends AbstractRow<TColumn,TCell>,TColumn extends Column,TCell extends Cell>
extends NamedModel<Long>

Constructor Summary

Constructors

Constructor and Description
AbstractSheet()

Method Summary

Modifier and Type	Method and Description
AccessLevel	getAccessLevel() Gets the access level for the sheet.
List<Attachment>	getAttachments() Gets the attachments for the sheet.
TColumn	getColumnById(long columnId) Get a Column by ID.
TColumn	getColumnByIndex(int index) Get a column by index.
List<TColumn>	getColumns() Gets the columns for the sheet.
List<ContactObjectValue>	getContactReferences() Sets contact references used by MULTI_CONTACT_LIST columns
Date	getCreatedAt() Gets the date and time the sheet was created.
List<CrossSheetReference>	getCrossSheetReferences() Gets the list of cross sheet references used by this sheet
Boolean	getDependenciesEnabled() Gets the dependencies enabled flag.
List<Discussion>	getDiscussions() Gets the discussions for the sheet.
EnumSet<AttachmentType>	getEffectiveAttachmentOptions() Gets the effective attachment options.
List<SheetFilter>	getFilters() Get the list of sheet filters for this sheet.
Long	getFromId() Gets the ID of the sheet/template from which the sheet was created.
Boolean	getGanttEnabled() Gets the gantt enabled flag.
Boolean	getHasSummaryFields() Gets flag indicating whether a sheet summary is present
Date	getModifiedAt() Gets the date and time the sheet was last modified.
String	getOwner() Gets the owner email.
Long	getOwnerId() Gets the owner id.
String	getPermalink() Gets the permalink for the sheet.
ProjectSettings	getProjectSettings() Gets the project settings.
Boolean	getReadOnly() Gets the read only flag for the sheet.
Boolean	getResourceManagementEnabled()
TRow	getRowByRowNumber(int rowNumber) Get a Row by row number.
List<TRow>	getRows() Gets the rows for the sheet.
Boolean	getShowParentRowsForFilters() True if show parent rows for filters.
Source	getSource() Gets the source.
SheetSummary	getSummary() Gets the sheet summary if one exists for this sheet
Integer	getTotalRowCount() Gets the total row count for the sheet.
SheetUserPermissions	getUserPermissions() Gets the sheet user permissions
SheetUserSettings	getUserSettings() Gets the sheet user settings.
Integer	getVersion() Gets the version for the sheet.
Workspace	getWorkspace() Gets a workspace object containing the name and id of the workspace containing this sheet
Boolean	isFavorite() True if the sheet is a favorite sheet.
AbstractSheet<TRow,TColumn,TCell>	setAccessLevel(AccessLevel accessLevel) Sets the access level for the sheet.
AbstractSheet<TRow,TColumn,TCell>	setAttachments(List<Attachment> attachments) Sets the attachments for the sheet.
AbstractSheet<TRow,TColumn,TCell>	setColumns(List<TColumn> columns) Sets the columns for the sheet.
AbstractSheet<TRow,TColumn,TCell>	setContactReferences(List<ContactObjectValue> contactReferences) Sets contact references used by MULTI_CONTACT_LIST columns
AbstractSheet<TRow,TColumn,TCell>	setCreatedAt(Date createdAt) Sets the date and time the sheet was created.
AbstractSheet<TRow,TColumn,TCell>	setCrossSheetReferences(List<CrossSheetReference> crossSheetReferences) Sets the list of cross sheet references used by this sheet
AbstractSheet<TRow,TColumn,TCell>	setDependenciesEnabled(Boolean dependenciesEnabled) Sets the dependencies enabled flag.
AbstractSheet<TRow,TColumn,TCell>	setDiscussions(List<Discussion> discussions) Sets the discussions for the sheet.
AbstractSheet<TRow,TColumn,TCell>	setEffectiveAttachmentOptions(EnumSet<AttachmentType> effectiveAttachmentOptions) Sets the effective attachment options.
AbstractSheet<TRow,TColumn,TCell>	setFavorite(Boolean favorite) Sets the favorite sheet
AbstractSheet<TRow,TColumn,TCell>	setFilters(List<SheetFilter> filters) Sets the list of sheet filters for this sheet.
AbstractSheet<TRow,TColumn,TCell>	setFromId(Long fromId) Sets the ID of the sheet/template from which the sheet was created.
AbstractSheet<TRow,TColumn,TCell>	setGanttEnabled(Boolean ganttEnabled) Sets the gantt enabled flag.
AbstractSheet<TRow,TColumn,TCell>	setHasSummaryFields(Boolean hasSummaryFields) Sets flag indicating whether a sheet summary is present
AbstractSheet<TRow,TColumn,TCell>	setModifiedAt(Date modifiedAt) Sets the date and time the sheet was last modified.
AbstractSheet<TRow,TColumn,TCell>	setName(String name) Provide an 'override' of setName (returns AbstractSheet not NamedModel)
AbstractSheet<TRow,TColumn,TCell>	setOwner(String owner) Sets the owner
AbstractSheet<TRow,TColumn,TCell>	setOwnerId(long ownerId) Sets the owner id.
AbstractSheet<TRow,TColumn,TCell>	setPermalink(String permalink) Sets the permalink for the sheet.
AbstractSheet<TRow,TColumn,TCell>	setProjectSettings(ProjectSettings projectSettings) Sets the project settings.
AbstractSheet<TRow,TColumn,TCell>	setReadOnly(Boolean readOnly) Sets the read only flag for the sheet.
AbstractSheet<TRow,TColumn,TCell>	setResourceManagementEnabled(Boolean resourceManagementEnabled)
AbstractSheet<TRow,TColumn,TCell>	setRows(List<TRow> rows) Sets the rows for the sheet.
AbstractSheet<TRow,TColumn,TCell>	setShowParentRowsForFilters(Boolean showParentRowsForFilters) Sets the show parent rows for filters.
AbstractSheet<TRow,TColumn,TCell>	setSource(Source source) Sets the source.
AbstractSheet<TRow,TColumn,TCell>	setSummary(SheetSummary summary) Sets the sheet summary if one exists for this sheet
AbstractSheet<TRow,TColumn,TCell>	setTotalRowCount(Integer totalRowCount) Sets the total row count.
AbstractSheet<TRow,TColumn,TCell>	setUserPermissions(SheetUserPermissions userPermissions) Sets the sheet user permissions
AbstractSheet<TRow,TColumn,TCell>	setUserSettings(SheetUserSettings userSettings) Sets the user settings.
AbstractSheet<TRow,TColumn,TCell>	setVersion(Integer version) Sets the version for the sheet.
AbstractSheet<TRow,TColumn,TCell>	setWorkspace(Workspace workspace) Sets a workspace object containing the name and id of the workspace containing this sheet

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

AbstractSheet

public AbstractSheet()

Method Detail

getFromId

public Long getFromId()

Gets the ID of the sheet/template from which the sheet was created.

Returns:

the from id

setFromId

public AbstractSheet<TRow,TColumn,TCell> setFromId(Long fromId)

Sets the ID of the sheet/template from which the sheet was created.

Parameters:

fromId - the new from id

getOwnerId

public Long getOwnerId()

Gets the owner id.

Returns:

the ownerid

setOwnerId

public AbstractSheet<TRow,TColumn,TCell> setOwnerId(long ownerId)

Sets the owner id.

Parameters:

ownerId - the owner id

getAccessLevel

public AccessLevel getAccessLevel()

Gets the access level for the sheet.

Returns:

the access level

setAccessLevel

public AbstractSheet<TRow,TColumn,TCell> setAccessLevel(AccessLevel accessLevel)

Sets the access level for the sheet.

Parameters:

accessLevel - the new access level

getAttachments

public List<Attachment> getAttachments()

Gets the attachments for the sheet.

Returns:

the attachments

setAttachments

public AbstractSheet<TRow,TColumn,TCell> setAttachments(List<Attachment> attachments)

Sets the attachments for the sheet.

Parameters:

attachments - the new attachments

getColumns

public List<TColumn> getColumns()

Gets the columns for the sheet.

Returns:

the columns

setColumns

public AbstractSheet<TRow,TColumn,TCell> setColumns(List<TColumn> columns)

Sets the columns for the sheet.

Parameters:

columns - the new columns

getContactReferences

public List<ContactObjectValue> getContactReferences()

Sets contact references used by MULTI_CONTACT_LIST columns

Returns:

contact references

setContactReferences

public AbstractSheet<TRow,TColumn,TCell> setContactReferences(List<ContactObjectValue> contactReferences)

Sets contact references used by MULTI_CONTACT_LIST columns

Parameters:

contactReferences -

getCreatedAt

public Date getCreatedAt()

Gets the date and time the sheet was created.

Returns:

the created at

setCreatedAt

public AbstractSheet<TRow,TColumn,TCell> setCreatedAt(Date createdAt)

Sets the date and time the sheet was created.

Parameters:

createdAt - the new created at

getCrossSheetReferences

public List<CrossSheetReference> getCrossSheetReferences()

Gets the list of cross sheet references used by this sheet

Returns:

the cross sheet references

setCrossSheetReferences

public AbstractSheet<TRow,TColumn,TCell> setCrossSheetReferences(List<CrossSheetReference> crossSheetReferences)

Sets the list of cross sheet references used by this sheet

Parameters:

crossSheetReferences - the cross sheet references

getDependenciesEnabled

public Boolean getDependenciesEnabled()

Gets the dependencies enabled flag.

Returns:

the dependencies enabled

setDependenciesEnabled

public AbstractSheet<TRow,TColumn,TCell> setDependenciesEnabled(Boolean dependenciesEnabled)

Sets the dependencies enabled flag.

Parameters:

dependenciesEnabled - the new dependencies enabled

getDiscussions

public List<Discussion> getDiscussions()

Gets the discussions for the sheet.

Returns:

the discussions

setDiscussions

public AbstractSheet<TRow,TColumn,TCell> setDiscussions(List<Discussion> discussions)

Sets the discussions for the sheet.

Parameters:

discussions - the new discussions

getEffectiveAttachmentOptions

public EnumSet<AttachmentType> getEffectiveAttachmentOptions()

Gets the effective attachment options.

Returns:

list of attachment types

setEffectiveAttachmentOptions

public AbstractSheet<TRow,TColumn,TCell> setEffectiveAttachmentOptions(EnumSet<AttachmentType> effectiveAttachmentOptions)

Sets the effective attachment options.

Parameters:

effectiveAttachmentOptions - the effective attachment options

isFavorite

public Boolean isFavorite()

True if the sheet is a favorite sheet.

Returns:

the favorite

setFavorite

public AbstractSheet<TRow,TColumn,TCell> setFavorite(Boolean favorite)

Sets the favorite sheet

Parameters:

favorite - the favorite

getFilters

public List<SheetFilter> getFilters()

Get the list of sheet filters for this sheet.

Returns:

the list of SheetFilters

setFilters

public AbstractSheet<TRow,TColumn,TCell> setFilters(List<SheetFilter> filters)

Sets the list of sheet filters for this sheet.

Parameters:

filters - the list of SheetFilters

getGanttEnabled

public Boolean getGanttEnabled()

Gets the gantt enabled flag.

Returns:

the gantt enabled flag

setGanttEnabled

public AbstractSheet<TRow,TColumn,TCell> setGanttEnabled(Boolean ganttEnabled)

Sets the gantt enabled flag.

Parameters:

ganttEnabled - the new gantt enabled flag

getHasSummaryFields

public Boolean getHasSummaryFields()

Gets flag indicating whether a sheet summary is present

Returns:

hasSheetSummary

setHasSummaryFields

public AbstractSheet<TRow,TColumn,TCell> setHasSummaryFields(Boolean hasSummaryFields)

Sets flag indicating whether a sheet summary is present

Parameters:

hasSummaryFields -

getModifiedAt

public Date getModifiedAt()

Gets the date and time the sheet was last modified.

Returns:

the modified at

setModifiedAt

public AbstractSheet<TRow,TColumn,TCell> setModifiedAt(Date modifiedAt)

Sets the date and time the sheet was last modified.

Parameters:

modifiedAt - the new modified at

setName

public AbstractSheet<TRow,TColumn,TCell> setName(String name)

Provide an 'override' of setName (returns AbstractSheet not NamedModel)

Overrides:

setName in class NamedModel<Long>

Parameters:

name - the new name

getOwner

public String getOwner()

Gets the owner email.

Returns:

the owner email

setOwner

public AbstractSheet<TRow,TColumn,TCell> setOwner(String owner)

Sets the owner

Parameters:

owner - the owner email

getPermalink

public String getPermalink()

Gets the permalink for the sheet.

Returns:

the permalink

setPermalink

public AbstractSheet<TRow,TColumn,TCell> setPermalink(String permalink)

Sets the permalink for the sheet.

Parameters:

permalink - the new permalink

getProjectSettings

public ProjectSettings getProjectSettings()

Gets the project settings.

Returns:

the project settings

setProjectSettings

public AbstractSheet<TRow,TColumn,TCell> setProjectSettings(ProjectSettings projectSettings)

Sets the project settings.

Parameters:

projectSettings - the project settings

getReadOnly

public Boolean getReadOnly()

Gets the read only flag for the sheet.

Returns:

the read only

setReadOnly

public AbstractSheet<TRow,TColumn,TCell> setReadOnly(Boolean readOnly)

Sets the read only flag for the sheet.

Parameters:

readOnly - the new read only

getResourceManagementEnabled

public Boolean getResourceManagementEnabled()

Returns:

the flag indicating if resource management is enabled.

setResourceManagementEnabled

public AbstractSheet<TRow,TColumn,TCell> setResourceManagementEnabled(Boolean resourceManagementEnabled)

Parameters:

resourceManagementEnabled - the resourceManagementEnabled to set

getRows

public List<TRow> getRows()

Gets the rows for the sheet.

Returns:

the rows

setRows

public AbstractSheet<TRow,TColumn,TCell> setRows(List<TRow> rows)

Sets the rows for the sheet.

Parameters:

rows - the new rows

getShowParentRowsForFilters

public Boolean getShowParentRowsForFilters()

True if show parent rows for filters.

Returns:

the show parent row for filters

setShowParentRowsForFilters

public AbstractSheet<TRow,TColumn,TCell> setShowParentRowsForFilters(Boolean showParentRowsForFilters)

Sets the show parent rows for filters.

Parameters:

showParentRowsForFilters - the show parent rows for filters

getSource

public Source getSource()

Gets the source.

Returns:

the source

setSource

public AbstractSheet<TRow,TColumn,TCell> setSource(Source source)

Sets the source.

Parameters:

source - the source

getSummary

public SheetSummary getSummary()

Gets the sheet summary if one exists for this sheet

Returns:

sheetSummary

setSummary

public AbstractSheet<TRow,TColumn,TCell> setSummary(SheetSummary summary)

Sets the sheet summary if one exists for this sheet

Parameters:

summary -

getTotalRowCount

public Integer getTotalRowCount()

Gets the total row count for the sheet.

Returns:

the total row count

setTotalRowCount

public AbstractSheet<TRow,TColumn,TCell> setTotalRowCount(Integer totalRowCount)

Sets the total row count.

Parameters:

totalRowCount - the total row count

getUserPermissions

public SheetUserPermissions getUserPermissions()

Gets the sheet user permissions

Returns:

userPermissions

setUserPermissions

public AbstractSheet<TRow,TColumn,TCell> setUserPermissions(SheetUserPermissions userPermissions)

Sets the sheet user permissions

Parameters:

userPermissions -

getUserSettings

public SheetUserSettings getUserSettings()

Gets the sheet user settings.

Returns:

the user settings

setUserSettings

public AbstractSheet<TRow,TColumn,TCell> setUserSettings(SheetUserSettings userSettings)

Sets the user settings.

Parameters:

userSettings - the user settings

getVersion

public Integer getVersion()

Gets the version for the sheet.

Returns:

the version

setVersion

public AbstractSheet<TRow,TColumn,TCell> setVersion(Integer version)

Sets the version for the sheet.

Parameters:

version - the new version

getWorkspace

public Workspace getWorkspace()

Gets a workspace object containing the name and id of the workspace containing this sheet

Returns:

workspace

setWorkspace

public AbstractSheet<TRow,TColumn,TCell> setWorkspace(Workspace workspace)

Sets a workspace object containing the name and id of the workspace containing this sheet

Parameters:

workspace -

getColumnByIndex

public TColumn getColumnByIndex(int index)

Get a column by index.

Parameters:

index - the column index

Returns:

the column by index

getColumnById

public TColumn getColumnById(long columnId)

Get a Column by ID.

Parameters:

columnId - the column id

Returns:

the column by id

getRowByRowNumber

public TRow getRowByRowNumber(int rowNumber)

Get a Row by row number.

Parameters:

rowNumber - the row number

Returns:

the row by row number