public class AbstractSheet<TRow extends AbstractRow<TColumn,TCell>,TColumn extends Column,TCell extends Cell> extends NamedModel<Long>
| Constructor and Description |
|---|
AbstractSheet() |
| 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
|
getNameequals, getId, hashCode, setIdpublic Long getFromId()
public AbstractSheet<TRow,TColumn,TCell> setFromId(Long fromId)
fromId - the new from idpublic Long getOwnerId()
public AbstractSheet<TRow,TColumn,TCell> setOwnerId(long ownerId)
ownerId - the owner idpublic AccessLevel getAccessLevel()
public AbstractSheet<TRow,TColumn,TCell> setAccessLevel(AccessLevel accessLevel)
accessLevel - the new access levelpublic List<Attachment> getAttachments()
public AbstractSheet<TRow,TColumn,TCell> setAttachments(List<Attachment> attachments)
attachments - the new attachmentspublic AbstractSheet<TRow,TColumn,TCell> setColumns(List<TColumn> columns)
columns - the new columnspublic List<ContactObjectValue> getContactReferences()
public AbstractSheet<TRow,TColumn,TCell> setContactReferences(List<ContactObjectValue> contactReferences)
contactReferences - public Date getCreatedAt()
public AbstractSheet<TRow,TColumn,TCell> setCreatedAt(Date createdAt)
createdAt - the new created atpublic List<CrossSheetReference> getCrossSheetReferences()
public AbstractSheet<TRow,TColumn,TCell> setCrossSheetReferences(List<CrossSheetReference> crossSheetReferences)
crossSheetReferences - the cross sheet referencespublic Boolean getDependenciesEnabled()
public AbstractSheet<TRow,TColumn,TCell> setDependenciesEnabled(Boolean dependenciesEnabled)
dependenciesEnabled - the new dependencies enabledpublic List<Discussion> getDiscussions()
public AbstractSheet<TRow,TColumn,TCell> setDiscussions(List<Discussion> discussions)
discussions - the new discussionspublic EnumSet<AttachmentType> getEffectiveAttachmentOptions()
public AbstractSheet<TRow,TColumn,TCell> setEffectiveAttachmentOptions(EnumSet<AttachmentType> effectiveAttachmentOptions)
effectiveAttachmentOptions - the effective attachment optionspublic Boolean isFavorite()
public AbstractSheet<TRow,TColumn,TCell> setFavorite(Boolean favorite)
favorite - the favoritepublic List<SheetFilter> getFilters()
public AbstractSheet<TRow,TColumn,TCell> setFilters(List<SheetFilter> filters)
filters - the list of SheetFilterspublic Boolean getGanttEnabled()
public AbstractSheet<TRow,TColumn,TCell> setGanttEnabled(Boolean ganttEnabled)
ganttEnabled - the new gantt enabled flagpublic Boolean getHasSummaryFields()
public AbstractSheet<TRow,TColumn,TCell> setHasSummaryFields(Boolean hasSummaryFields)
hasSummaryFields - public Date getModifiedAt()
public AbstractSheet<TRow,TColumn,TCell> setModifiedAt(Date modifiedAt)
modifiedAt - the new modified atpublic AbstractSheet<TRow,TColumn,TCell> setName(String name)
setName in class NamedModel<Long>name - the new namepublic String getOwner()
public AbstractSheet<TRow,TColumn,TCell> setOwner(String owner)
owner - the owner emailpublic String getPermalink()
public AbstractSheet<TRow,TColumn,TCell> setPermalink(String permalink)
permalink - the new permalinkpublic ProjectSettings getProjectSettings()
public AbstractSheet<TRow,TColumn,TCell> setProjectSettings(ProjectSettings projectSettings)
projectSettings - the project settingspublic Boolean getReadOnly()
public AbstractSheet<TRow,TColumn,TCell> setReadOnly(Boolean readOnly)
readOnly - the new read onlypublic Boolean getResourceManagementEnabled()
public AbstractSheet<TRow,TColumn,TCell> setResourceManagementEnabled(Boolean resourceManagementEnabled)
resourceManagementEnabled - the resourceManagementEnabled to setpublic AbstractSheet<TRow,TColumn,TCell> setRows(List<TRow> rows)
rows - the new rowspublic Boolean getShowParentRowsForFilters()
public AbstractSheet<TRow,TColumn,TCell> setShowParentRowsForFilters(Boolean showParentRowsForFilters)
showParentRowsForFilters - the show parent rows for filterspublic Source getSource()
public AbstractSheet<TRow,TColumn,TCell> setSource(Source source)
source - the sourcepublic SheetSummary getSummary()
public AbstractSheet<TRow,TColumn,TCell> setSummary(SheetSummary summary)
summary - public Integer getTotalRowCount()
public AbstractSheet<TRow,TColumn,TCell> setTotalRowCount(Integer totalRowCount)
totalRowCount - the total row countpublic SheetUserPermissions getUserPermissions()
public AbstractSheet<TRow,TColumn,TCell> setUserPermissions(SheetUserPermissions userPermissions)
userPermissions - public SheetUserSettings getUserSettings()
public AbstractSheet<TRow,TColumn,TCell> setUserSettings(SheetUserSettings userSettings)
userSettings - the user settingspublic Integer getVersion()
public AbstractSheet<TRow,TColumn,TCell> setVersion(Integer version)
version - the new versionpublic Workspace getWorkspace()
public AbstractSheet<TRow,TColumn,TCell> setWorkspace(Workspace workspace)
workspace - public TColumn getColumnByIndex(int index)
index - the column indexpublic TColumn getColumnById(long columnId)
Column by ID.columnId - the column idCopyright © 2014–2019 Smartsheet. All rights reserved.