Package com.smartsheet.api.models
Class AbstractRow<TColumn extends Column,TCell extends Cell>
- java.lang.Object
-
- com.smartsheet.api.models.IdentifiableModel<java.lang.Long>
-
- com.smartsheet.api.models.AbstractRow<TColumn,TCell>
-
public abstract class AbstractRow<TColumn extends Column,TCell extends Cell> extends IdentifiableModel<java.lang.Long>
-
-
Constructor Summary
Constructors Constructor Description AbstractRow()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Boolean
getAbove()
Gets the above.AccessLevel
getAccessLevel()
Gets the user's permissions on the sheet.java.util.List<Attachment>
getAttachments()
Gets the attachments.java.util.List<TCell>
getCells()
Gets the cells.TColumn
getColumnById(long columnId)
Get a column by it's ID.TColumn
getColumnByIndex(int index)
Get a column by it's index.java.util.List<TColumn>
getColumns()
Gets the columns.Format
getConditionalFormat()
java.util.Date
getCreatedAt()
Gets the date and time a row was created.User
getCreatedBy()
Gets the User object containing name and email of the creator of this row.java.util.List<Discussion>
getDiscussions()
Gets the discussions.Format
getFormat()
java.lang.Long
getId()
Gets the id.java.lang.Integer
getIndent()
Get integer value specifying the number of levels to indent this row (update only).java.util.Date
getModifiedAt()
Gets the date and time a row was modified.User
getModifiedBy()
Gets the User object containing name and email of the last person to modify this row.java.lang.Integer
getOutdent()
Get integer value specifying the number of levels to outdent this row (update only).java.lang.Long
getParentId()
Gets the row's parent ID.java.lang.Integer
getParentRowNumber()
Gets the parent row number.java.lang.String
getPermalink()
Gets the row's permalink URL.java.lang.Long
getRowId()
java.lang.Integer
getRowNumber()
Gets the row number.java.lang.Long
getSheetId()
Gets the id of the sheet.java.lang.Long
getSiblingId()
Gets the row's sibling ID.java.lang.Boolean
getToBottom()
Gets the to bottom.java.lang.Boolean
getToTop()
Gets the to top.java.lang.Integer
getVersion()
Gets the version number that is incremented every time a sheet is modified.java.lang.Boolean
isExpanded()
Checks if the row is expanded.java.lang.Boolean
isFilteredOut()
Check if the row is filtered outjava.lang.Boolean
isInCriticalPath()
Check if the row is in critical pathjava.lang.Boolean
isLocked()
Indicates whether a row is locked or not.java.lang.Boolean
isLockedForUser()
Indicates whether a row is locked for the user.<T extends AbstractRow<TColumn,TCell>>
TsetAbove(java.lang.Boolean above)
Sets the above<T extends AbstractRow<TColumn,TCell>>
TsetAccessLevel(AccessLevel accessLevel)
Sets the user's permissions on the sheet.<T extends AbstractRow<TColumn,TCell>>
TsetAttachments(java.util.List<Attachment> attachments)
Sets the attachments.<T extends AbstractRow<TColumn,TCell>>
TsetCells(java.util.List<TCell> cells)
Sets the cells.<T extends AbstractRow<TColumn,TCell>>
TsetColumns(java.util.List<TColumn> columns)
Sets the columns.<T extends AbstractRow<TColumn,TCell>>
TsetConditionalFormat(Format conditionalFormat)
Sets the conditional format of the row.<T extends AbstractRow<TColumn,TCell>>
TsetCreatedAt(java.util.Date createdAt)
Sets the date and time a row was created.<T extends AbstractRow<TColumn,TCell>>
TsetDiscussions(java.util.List<Discussion> discussions)
Sets the discussions.<T extends AbstractRow<TColumn,TCell>>
TsetExpanded(java.lang.Boolean expanded)
Sets the row to be expanded.<T extends AbstractRow<TColumn,TCell>>
TsetFilteredOut(java.lang.Boolean filteredOut)
Sets the row to be filtered out.<T extends AbstractRow<TColumn,TCell>>
TsetFormat(Format format)
IdentifiableModel<java.lang.Long>
setId(java.lang.Long id)
Sets the id.<T extends AbstractRow<TColumn,TCell>>
TsetInCriticalPath(java.lang.Boolean inCriticalPath)
Sets the row to be in critical path.<T extends AbstractRow<TColumn,TCell>>
TsetIndent(java.lang.Integer indent)
Sets integer value specifying the number of levels to indent this row (update only).<T extends AbstractRow<TColumn,TCell>>
TsetLocked(java.lang.Boolean locked)
<T extends AbstractRow<TColumn,TCell>>
TsetLockedForUser(java.lang.Boolean lockedForUser)
Set locked For User<T extends AbstractRow<TColumn,TCell>>
TsetModifiedAt(java.util.Date modifiedAt)
Sets the date and time a row was modified.<T extends AbstractRow<TColumn,TCell>>
TsetOutdent(java.lang.Integer outdent)
Sets integer value specifying the number of levels to outdent this row (update only).<T extends AbstractRow<TColumn,TCell>>
TsetParentId(java.lang.Long parentId)
Sets the parent row id.<T extends AbstractRow<TColumn,TCell>>
TsetParentRowNumber(java.lang.Integer parentRowNumber)
Sets the parent row number.<T extends AbstractRow<TColumn,TCell>>
TsetPermalink(java.lang.String permalink)
Sets the parmalink URL.<T extends AbstractRow<TColumn,TCell>>
TsetRowId(java.lang.Long id)
Set the Row ID<T extends AbstractRow<TColumn,TCell>>
TsetRowNumber(java.lang.Integer rowNumber)
Sets the row number.<T extends AbstractRow<TColumn,TCell>>
TsetSheetId(java.lang.Long sheetId)
Sets the sheet id.<T extends AbstractRow<TColumn,TCell>>
TsetSiblingId(java.lang.Long siblingId)
Sets the sibling row id.<T extends AbstractRow<TColumn,TCell>>
TsetToBottom(java.lang.Boolean toBottom)
Sets the to bottom<T extends AbstractRow<TColumn,TCell>>
TsetToTop(java.lang.Boolean toTop)
Sets the to top<T extends AbstractRow<TColumn,TCell>>
TsetVersion(java.lang.Integer version)
Sets the version number that is incremented every time a sheet is modified..-
Methods inherited from class com.smartsheet.api.models.IdentifiableModel
equals, hashCode
-
-
-
-
Method Detail
-
getId
public java.lang.Long getId()
Description copied from class:IdentifiableModel
Gets the id.- Overrides:
getId
in classIdentifiableModel<java.lang.Long>
- Returns:
- the id
-
setId
public IdentifiableModel<java.lang.Long> setId(java.lang.Long id)
Description copied from class:IdentifiableModel
Sets the id.- Overrides:
setId
in classIdentifiableModel<java.lang.Long>
- Parameters:
id
- the new id
-
getRowId
public java.lang.Long getRowId()
-
setRowId
public <T extends AbstractRow<TColumn,TCell>> T setRowId(java.lang.Long id)
Set the Row ID
-
getAccessLevel
public AccessLevel getAccessLevel()
Gets the user's permissions on the sheet.- Returns:
- the access level
-
setAccessLevel
public <T extends AbstractRow<TColumn,TCell>> T setAccessLevel(AccessLevel accessLevel)
Sets the user's permissions on the sheet.- Parameters:
accessLevel
- the new access level
-
getVersion
public java.lang.Integer getVersion()
Gets the version number that is incremented every time a sheet is modified.- Returns:
- the version
-
setVersion
public <T extends AbstractRow<TColumn,TCell>> T setVersion(java.lang.Integer version)
Sets the version number that is incremented every time a sheet is modified..- Parameters:
version
- the new version
-
isExpanded
public java.lang.Boolean isExpanded()
Checks if the row is expanded.- Returns:
- true, if is expanded
-
setExpanded
public <T extends AbstractRow<TColumn,TCell>> T setExpanded(java.lang.Boolean expanded)
Sets the row to be expanded.- Parameters:
expanded
- the new expanded
-
getColumnByIndex
public TColumn getColumnByIndex(int index)
Get a column by it's index.- Parameters:
index
- the column index- Returns:
- the column by index
-
getColumnById
public TColumn getColumnById(long columnId)
Get a column by it's ID.- Parameters:
columnId
- the column id- Returns:
- the column by id
-
getSheetId
public java.lang.Long getSheetId()
Gets the id of the sheet.- Returns:
- the sheet id
-
setSheetId
public <T extends AbstractRow<TColumn,TCell>> T setSheetId(java.lang.Long sheetId)
Sets the sheet id.- Parameters:
sheetId
- the new sheet id
-
getRowNumber
public java.lang.Integer getRowNumber()
Gets the row number.- Returns:
- the row number
-
setRowNumber
public <T extends AbstractRow<TColumn,TCell>> T setRowNumber(java.lang.Integer rowNumber)
Sets the row number.- Parameters:
rowNumber
- the new row number
-
getParentRowNumber
public java.lang.Integer getParentRowNumber()
Gets the parent row number.- Returns:
- the parent row number
-
setParentRowNumber
public <T extends AbstractRow<TColumn,TCell>> T setParentRowNumber(java.lang.Integer parentRowNumber)
Sets the parent row number.- Parameters:
parentRowNumber
- the new parent row number
-
getCells
public java.util.List<TCell> getCells()
Gets the cells.- Returns:
- the cells
-
setCells
public <T extends AbstractRow<TColumn,TCell>> T setCells(java.util.List<TCell> cells)
Sets the cells.- Parameters:
cells
- the new cells
-
getDiscussions
public java.util.List<Discussion> getDiscussions()
Gets the discussions.- Returns:
- the discussions
-
setDiscussions
public <T extends AbstractRow<TColumn,TCell>> T setDiscussions(java.util.List<Discussion> discussions)
Sets the discussions.- Parameters:
discussions
- the new discussions
-
getAttachments
public java.util.List<Attachment> getAttachments()
Gets the attachments.- Returns:
- the attachments
-
setAttachments
public <T extends AbstractRow<TColumn,TCell>> T setAttachments(java.util.List<Attachment> attachments)
Sets the attachments.- Parameters:
attachments
- the new attachments
-
getColumns
public java.util.List<TColumn> getColumns()
Gets the columns.- Returns:
- the columns
-
setColumns
public <T extends AbstractRow<TColumn,TCell>> T setColumns(java.util.List<TColumn> columns)
Sets the columns.- Parameters:
columns
- the new columns
-
getCreatedAt
public java.util.Date getCreatedAt()
Gets the date and time a row was created.- Returns:
- the created at
-
setCreatedAt
public <T extends AbstractRow<TColumn,TCell>> T setCreatedAt(java.util.Date createdAt)
Sets the date and time a row was created.- Parameters:
createdAt
- the new created at
-
getModifiedAt
public java.util.Date getModifiedAt()
Gets the date and time a row was modified.- Returns:
- the modified at
-
setModifiedAt
public <T extends AbstractRow<TColumn,TCell>> T setModifiedAt(java.util.Date modifiedAt)
Sets the date and time a row was modified.- Parameters:
modifiedAt
- the new modified at
-
isLocked
public java.lang.Boolean isLocked()
Indicates whether a row is locked or not.- Returns:
- the locked status
-
setLocked
public <T extends AbstractRow<TColumn,TCell>> T setLocked(java.lang.Boolean locked)
- Parameters:
locked
- the locked status
-
isLockedForUser
public java.lang.Boolean isLockedForUser()
Indicates whether a row is locked for the user. Users cannot modify rows that are locked for them.- Returns:
- the lock status for the user
-
setLockedForUser
public <T extends AbstractRow<TColumn,TCell>> T setLockedForUser(java.lang.Boolean lockedForUser)
Set locked For User
-
setFormat
public <T extends AbstractRow<TColumn,TCell>> T setFormat(Format format)
- Parameters:
format
- theFormat
to set
-
getParentId
public java.lang.Long getParentId()
Gets the row's parent ID.- Returns:
- the ID of the parent
-
setParentId
public <T extends AbstractRow<TColumn,TCell>> T setParentId(java.lang.Long parentId)
Sets the parent row id.- Parameters:
parentId
- the parent row id
-
getSiblingId
public java.lang.Long getSiblingId()
Gets the row's sibling ID.- Returns:
- the ID of the sibling
-
setSiblingId
public <T extends AbstractRow<TColumn,TCell>> T setSiblingId(java.lang.Long siblingId)
Sets the sibling row id.- Parameters:
siblingId
- the sibling row id
-
getPermalink
public java.lang.String getPermalink()
Gets the row's permalink URL.- Returns:
- the permalink URL of the row
-
setPermalink
public <T extends AbstractRow<TColumn,TCell>> T setPermalink(java.lang.String permalink)
Sets the parmalink URL.- Parameters:
permalink
- the URL to the row
-
isFilteredOut
public java.lang.Boolean isFilteredOut()
Check if the row is filtered out- Returns:
- true, if it is filtered out
-
setFilteredOut
public <T extends AbstractRow<TColumn,TCell>> T setFilteredOut(java.lang.Boolean filteredOut)
Sets the row to be filtered out.- Parameters:
filteredOut
- if the row is filtered out
-
isInCriticalPath
public java.lang.Boolean isInCriticalPath()
Check if the row is in critical path- Returns:
- true, if it is in critical path
-
setInCriticalPath
public <T extends AbstractRow<TColumn,TCell>> T setInCriticalPath(java.lang.Boolean inCriticalPath)
Sets the row to be in critical path.- Parameters:
inCriticalPath
- if the row is in critical path
-
setConditionalFormat
public <T extends AbstractRow<TColumn,TCell>> T setConditionalFormat(Format conditionalFormat)
Sets the conditional format of the row.- Parameters:
conditionalFormat
- the conditional format
-
getToTop
public java.lang.Boolean getToTop()
Gets the to top.- Returns:
- true, if row should be at the top
-
setToTop
public <T extends AbstractRow<TColumn,TCell>> T setToTop(java.lang.Boolean toTop)
Sets the to top- Parameters:
toTop
- if the row is to the top
-
getToBottom
public java.lang.Boolean getToBottom()
Gets the to bottom.- Returns:
- true, if row should be at the bottom
-
setToBottom
public <T extends AbstractRow<TColumn,TCell>> T setToBottom(java.lang.Boolean toBottom)
Sets the to bottom- Parameters:
toBottom
- if the row is to the bottom
-
getAbove
public java.lang.Boolean getAbove()
Gets the above.- Returns:
- true, if row should be above the specified sibling ID
-
setAbove
public <T extends AbstractRow<TColumn,TCell>> T setAbove(java.lang.Boolean above)
Sets the above- Parameters:
above
- if the row is above a specified row
-
getIndent
public java.lang.Integer getIndent()
Get integer value specifying the number of levels to indent this row (update only).- Returns:
- value specifying the number of levels to indent this row
-
setIndent
public <T extends AbstractRow<TColumn,TCell>> T setIndent(java.lang.Integer indent)
Sets integer value specifying the number of levels to indent this row (update only).- Parameters:
indent
- integer value specifying the number of levels to indent
-
getOutdent
public java.lang.Integer getOutdent()
Get integer value specifying the number of levels to outdent this row (update only).- Returns:
- value specifying the number of levels to outdent this row
-
setOutdent
public <T extends AbstractRow<TColumn,TCell>> T setOutdent(java.lang.Integer outdent)
Sets integer value specifying the number of levels to outdent this row (update only).- Parameters:
outdent
- integer value specifying number of levels to outdent
-
getCreatedBy
public User getCreatedBy()
Gets the User object containing name and email of the creator of this row.- Returns:
- User object
-
getModifiedBy
public User getModifiedBy()
Gets the User object containing name and email of the last person to modify this row.- Returns:
- User object
-
-