com.smartsheet.api.models

Class Sight

java.lang.Object

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

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

com.smartsheet.api.models.Sight

public class Sight
extends NamedModel<Long>

Constructor Summary

Constructors

Constructor and Description
Sight()

Method Summary

Modifier and Type	Method and Description
AccessLevel	getAccessLevel() User's permissions on the Sight (OWNDER, ADMIN, VIEWER)
String	getBackgroundColor() Get the background color of the Sight
Integer	getColumnCount() Get the number of columns that the Sight contains
Date	getCreatedAt() Get time of Sight creation
Boolean	getFavorite() Get flag indicating whether the user has marked the Sight as a favorite
Date	getModifiedAt() Get time of last modification
String	getPermalink() URL that represents a direct link to the Sight
List<Widget>	getWidgets() Get the array of Sight widgets
Workspace	getWorkspace() A workspace object limited to only id and name
Sight	setAccessLevel(AccessLevel accessLevel) Set User's permissions on the Sight
Sight	setBackgroundColor(String backgroundColor) Set the background color of the Sight
Sight	setColumnCount(Integer columnCount) Set the number of columns that the Sight contains
Sight	setCreatedAt(Date createdAt) Set time of Sight creation
Sight	setFavorite(Boolean favorite) Set flag indicating whether the user has marked the Sight as a favorite
Sight	setModifiedAt(Date modifiedAt) Set time of last modification
Sight	setName(String name) Provide an 'override' of setName (returns Sight not NamedModel)
Sight	setPermalink(String permalink) Set URL pointing to a direct link to the Sight
Sight	setWidgets(List<Widget> widgets) Set the array of Sight widgets
Sight	setWorkspace(Workspace workspace) Set workspace object for this Sight (limited to only id and name)

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

Sight

public Sight()

Method Detail

setName

public Sight setName(String name)

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

Overrides:

setName in class NamedModel<Long>

Parameters:

name - the new name

getColumnCount

public Integer getColumnCount()

Get the number of columns that the Sight contains

Returns:

columnCount

setColumnCount

public Sight setColumnCount(Integer columnCount)

Set the number of columns that the Sight contains

Parameters:

columnCount -

getWidgets

public List<Widget> getWidgets()

Get the array of Sight widgets

Returns:

array of widgets

setWidgets

public Sight setWidgets(List<Widget> widgets)

Set the array of Sight widgets

Parameters:

widgets -

getFavorite

public Boolean getFavorite()

Get flag indicating whether the user has marked the Sight as a favorite

Returns:

favorite flag

setFavorite

public Sight setFavorite(Boolean favorite)

Set flag indicating whether the user has marked the Sight as a favorite

Parameters:

favorite -

getAccessLevel

public AccessLevel getAccessLevel()

User's permissions on the Sight (OWNDER, ADMIN, VIEWER)

Returns:

accessLevel

setAccessLevel

public Sight setAccessLevel(AccessLevel accessLevel)

Set User's permissions on the Sight

Parameters:

accessLevel -

getPermalink

public String getPermalink()

URL that represents a direct link to the Sight

Returns:

permalink

setPermalink

public Sight setPermalink(String permalink)

Set URL pointing to a direct link to the Sight

Parameters:

permalink -

getCreatedAt

public Date getCreatedAt()

Get time of Sight creation

Returns:

createdAt (Date)

setCreatedAt

public Sight setCreatedAt(Date createdAt)

Set time of Sight creation

Parameters:

createdAt -

getModifiedAt

public Date getModifiedAt()

Get time of last modification

Returns:

modifiedAt (Date)

setModifiedAt

public Sight setModifiedAt(Date modifiedAt)

Set time of last modification

Parameters:

modifiedAt -

getWorkspace

public Workspace getWorkspace()

A workspace object limited to only id and name

Returns:

workspace

setWorkspace

public Sight setWorkspace(Workspace workspace)

Set workspace object for this Sight (limited to only id and name)

Parameters:

workspace -

getBackgroundColor

public String getBackgroundColor()

Get the background color of the Sight

Returns:

the background color

setBackgroundColor

public Sight setBackgroundColor(String backgroundColor)

Set the background color of the Sight

Parameters:

backgroundColor - the background color