com.smartsheet.api.models

Class AbstractRow<TColumn extends Column,TCell extends Cell>

java.lang.Object

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

com.smartsheet.api.models.AbstractRow<TColumn,TCell>

Direct Known Subclasses:

ReportRow, Row

public class AbstractRow<TColumn extends Column,TCell extends Cell>
extends IdentifiableModel<Long>

Constructor Summary

Constructors

Constructor and Description
AbstractRow()

Method Summary

Modifier and Type	Method and Description
Boolean	getAbove() Gets the above.
AccessLevel	getAccessLevel() Gets the user's permissions on the sheet.
List<Attachment>	getAttachments() Gets the attachments.
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.
List<TColumn>	getColumns() Gets the columns.
Format	getConditionalFormat()
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.
List<Discussion>	getDiscussions() Gets the discussions.
Format	getFormat()
Long	getId() Gets the id.
Integer	getIndent() Get integer value specifying the number of levels to indent this row (update only).
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.
Integer	getOutdent() Get integer value specifying the number of levels to outdent this row (update only).
Long	getParentId() Gets the row's parent ID.
Integer	getParentRowNumber() Gets the parent row number.
String	getPermalink() Gets the row's permalink URL.
Integer	getRowNumber() Gets the row number.
Long	getSheetId() Gets the id of the sheet.
Long	getSiblingId() Gets the row's sibling ID.
Boolean	getToBottom() Gets the to bottom.
Boolean	getToTop() Gets the to top.
Integer	getVersion() Gets the version number that is incremented every time a sheet is modified.
Boolean	isExpanded() Checks if the row is expanded.
Boolean	isFilteredOut() Check if the row is filtered out
Boolean	isInCriticalPath() Check if the row is in critical path
Boolean	isLocked() Indicates whether a row is locked or not.
Boolean	isLockedForUser() Indicates whether a row is locked for the user.
AbstractRow<TColumn,TCell>	setAbove(Boolean above) Sets the above
AbstractRow<TColumn,TCell>	setAccessLevel(AccessLevel accessLevel) Sets the user's permissions on the sheet.
AbstractRow<TColumn,TCell>	setAttachments(List<Attachment> attachments) Sets the attachments.
AbstractRow<TColumn,TCell>	setCells(List<TCell> cells) Sets the cells.
AbstractRow<TColumn,TCell>	setColumns(List<TColumn> columns) Sets the columns.
AbstractRow<TColumn,TCell>	setConditionalFormat(Format conditionalFormat) Sets the conditional format of the row.
AbstractRow<TColumn,TCell>	setCreatedAt(Date createdAt) Sets the date and time a row was created.
AbstractRow<TColumn,TCell>	setDiscussions(List<Discussion> discussions) Sets the discussions.
AbstractRow<TColumn,TCell>	setExpanded(Boolean expanded) Sets the row to be expanded.
AbstractRow<TColumn,TCell>	setFilteredOut(Boolean filteredOut) Sets the row to be filtered out.
AbstractRow<TColumn,TCell>	setFormat(Format format)
IdentifiableModel<Long>	setId(Long id) Sets the id.
AbstractRow<TColumn,TCell>	setInCriticalPath(Boolean inCriticalPath) Sets the row to be in critical path.
AbstractRow<TColumn,TCell>	setIndent(Integer indent) Sets integer value specifying the number of levels to indent this row (update only).
AbstractRow<TColumn,TCell>	setLocked(Boolean locked)
AbstractRow<TColumn,TCell>	setLockedForUser(Boolean lockedForUser)
AbstractRow<TColumn,TCell>	setModifiedAt(Date modifiedAt) Sets the date and time a row was modified.
AbstractRow<TColumn,TCell>	setOutdent(Integer outdent) Sets integer value specifying the number of levels to outdent this row (update only).
AbstractRow<TColumn,TCell>	setParentId(Long parentId) Sets the parent row id.
AbstractRow<TColumn,TCell>	setParentRowNumber(Integer parentRowNumber) Sets the parent row number.
AbstractRow<TColumn,TCell>	setPermalink(String permalink) Sets the parmalink URL.
AbstractRow<TColumn,TCell>	setRowNumber(Integer rowNumber) Sets the row number.
AbstractRow<TColumn,TCell>	setSheetId(Long sheetId) Sets the sheet id.
AbstractRow<TColumn,TCell>	setSiblingId(Long siblingId) Sets the sibling row id.
AbstractRow<TColumn,TCell>	setToBottom(Boolean toBottom) Sets the to bottom
AbstractRow<TColumn,TCell>	setToTop(Boolean toTop) Sets the to top
AbstractRow<TColumn,TCell>	setVersion(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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRow

public AbstractRow()

Method Detail

getId

public Long getId()

Description copied from class: IdentifiableModel

Gets the id.

Overrides:

getId in class IdentifiableModel<Long>

Returns:

the id

setId

public IdentifiableModel<Long> setId(Long id)

Description copied from class: IdentifiableModel

Sets the id.

Overrides:

setId in class IdentifiableModel<Long>

Parameters:

id - the new id

getAccessLevel

public AccessLevel getAccessLevel()

Gets the user's permissions on the sheet.

Returns:

the access level

setAccessLevel

public AbstractRow<TColumn,TCell> setAccessLevel(AccessLevel accessLevel)

Sets the user's permissions on the sheet.

Parameters:

accessLevel - the new access level

getVersion

public Integer getVersion()

Gets the version number that is incremented every time a sheet is modified.

Returns:

the version

setVersion

public AbstractRow<TColumn,TCell> setVersion(Integer version)

Sets the version number that is incremented every time a sheet is modified..

Parameters:

version - the new version

isExpanded

public Boolean isExpanded()

Checks if the row is expanded.

Returns:

true, if is expanded

setExpanded

public AbstractRow<TColumn,TCell> setExpanded(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 Long getSheetId()

Gets the id of the sheet.

Returns:

the sheet id

setSheetId

public AbstractRow<TColumn,TCell> setSheetId(Long sheetId)

Sets the sheet id.

Parameters:

sheetId - the new sheet id

getRowNumber

public Integer getRowNumber()

Gets the row number.

Returns:

the row number

setRowNumber

public AbstractRow<TColumn,TCell> setRowNumber(Integer rowNumber)

Sets the row number.

Parameters:

rowNumber - the new row number

getParentRowNumber

public Integer getParentRowNumber()

Gets the parent row number.

Returns:

the parent row number

setParentRowNumber

public AbstractRow<TColumn,TCell> setParentRowNumber(Integer parentRowNumber)

Sets the parent row number.

Parameters:

parentRowNumber - the new parent row number

getCells

public List<TCell> getCells()

Gets the cells.

Returns:

the cells

setCells

public AbstractRow<TColumn,TCell> setCells(List<TCell> cells)

Sets the cells.

Parameters:

cells - the new cells

getDiscussions

public List<Discussion> getDiscussions()

Gets the discussions.

Returns:

the discussions

setDiscussions

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

Sets the discussions.

Parameters:

discussions - the new discussions

getAttachments

public List<Attachment> getAttachments()

Gets the attachments.

Returns:

the attachments

setAttachments

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

Sets the attachments.

Parameters:

attachments - the new attachments

getColumns

public List<TColumn> getColumns()

Gets the columns.

Returns:

the columns

setColumns

public AbstractRow<TColumn,TCell> setColumns(List<TColumn> columns)

Sets the columns.

Parameters:

columns - the new columns

getCreatedAt

public Date getCreatedAt()

Gets the date and time a row was created.

Returns:

the created at

setCreatedAt

public AbstractRow<TColumn,TCell> setCreatedAt(Date createdAt)

Sets the date and time a row was created.

Parameters:

createdAt - the new created at

getModifiedAt

public Date getModifiedAt()

Gets the date and time a row was modified.

Returns:

the modified at

setModifiedAt

public AbstractRow<TColumn,TCell> setModifiedAt(Date modifiedAt)

Sets the date and time a row was modified.

Parameters:

modifiedAt - the new modified at

isLocked

public Boolean isLocked()

Indicates whether a row is locked or not.

Returns:

the locked status

setLocked

public AbstractRow<TColumn,TCell> setLocked(Boolean locked)

Parameters:

locked - the locked status

isLockedForUser

public 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 AbstractRow<TColumn,TCell> setLockedForUser(Boolean lockedForUser)

getFormat

public Format getFormat()

Returns:

the Format

setFormat

public AbstractRow<TColumn,TCell> setFormat(Format format)

Parameters:

format - the Format to set

getParentId

public Long getParentId()

Gets the row's parent ID.

Returns:

the ID of the parent

setParentId

public AbstractRow<TColumn,TCell> setParentId(Long parentId)

Sets the parent row id.

Parameters:

parentId - the parent row id

getSiblingId

public Long getSiblingId()

Gets the row's sibling ID.

Returns:

the ID of the sibling

setSiblingId

public AbstractRow<TColumn,TCell> setSiblingId(Long siblingId)

Sets the sibling row id.

Parameters:

siblingId - the sibling row id

getPermalink

public String getPermalink()

Gets the row's permalink URL.

Returns:

the permalink URL of the row

setPermalink

public AbstractRow<TColumn,TCell> setPermalink(String permalink)

Sets the parmalink URL.

Parameters:

permalink - the URL to the row

isFilteredOut

public Boolean isFilteredOut()

Check if the row is filtered out

Returns:

true, if it is filtered out

setFilteredOut

public AbstractRow<TColumn,TCell> setFilteredOut(Boolean filteredOut)

Sets the row to be filtered out.

Parameters:

filteredOut - if the row is filtered out

isInCriticalPath

public Boolean isInCriticalPath()

Check if the row is in critical path

Returns:

true, if it is in critical path

setInCriticalPath

public AbstractRow<TColumn,TCell> setInCriticalPath(Boolean inCriticalPath)

Sets the row to be in critical path.

Parameters:

inCriticalPath - if the row is in critical path

getConditionalFormat

public Format getConditionalFormat()

Returns:

the conditional Format

setConditionalFormat

public AbstractRow<TColumn,TCell> setConditionalFormat(Format conditionalFormat)

Sets the conditional format of the row.

Parameters:

conditionalFormat - the conditional format

getToTop

public Boolean getToTop()

Gets the to top.

Returns:

true, if row should be at the top

setToTop

public AbstractRow<TColumn,TCell> setToTop(Boolean toTop)

Sets the to top

Parameters:

toTop - if the row is to the top

getToBottom

public Boolean getToBottom()

Gets the to bottom.

Returns:

true, if row should be at the bottom

setToBottom

public AbstractRow<TColumn,TCell> setToBottom(Boolean toBottom)

Sets the to bottom

Parameters:

toBottom - if the row is to the bottom

getAbove

public Boolean getAbove()

Gets the above.

Returns:

true, if row should be above the specified sibling ID

setAbove

public AbstractRow<TColumn,TCell> setAbove(Boolean above)

Sets the above

Parameters:

above - if the row is above a specified row

getIndent

public 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 AbstractRow<TColumn,TCell> setIndent(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 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 AbstractRow<TColumn,TCell> setOutdent(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