com.smartsheet.api.models

Class Folder

java.lang.Object

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

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

com.smartsheet.api.models.Folder

Direct Known Subclasses:

Workspace

public class Folder
extends NamedModel<Long>

Represents a folder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Folder.CreateFolderBuilder A convenience class for setting up a folder with the appropriate fields for updating the folder.
static class	Folder.UpdateFolderBuilder A convenience class for setting up a folder with the appropriate fields for updating the folder.

Constructor Summary

Constructors

Constructor and Description
Folder() Default constructor
Folder(Long id) Construct a Folder with specified id

Method Summary

Modifier and Type	Method and Description
Boolean	getFavorite() Gets the favorite boolean value of folder in Home.
List<Folder>	getFolders() Gets the folders contained in this folder.
String	getPermalink() Gets the Direct URL to Folder.
List<Report>	getReports() Gets the reports.
List<Sheet>	getSheets() Gets the sheets in the folder.
List<Sight>	getSights() Get the sights contained in this folder
List<Template>	getTemplates() Gets the templates contained in this folder.
Folder	setFavorite(Boolean favorite) Sets the favorite boolean value of folder in Home.
Folder	setFolders(List<Folder> folders) Sets the folders contained in this folder.
Folder	setName(String name) Provide an 'override' of setName (returns Folder not NamedModel)
Folder	setPermalink(String permalink) Sets the Direct URL to Folder.
Folder	setReports(List<Report> reports) Sets the reports.
Folder	setSheets(List<Sheet> sheets) Sets the sheets contained in the folder.
Folder	setSights(List<Sight> sights) Sets the sights contained in this folder.
Folder	setTemplates(List<Template> templates) Sets the templates contained in this folder.

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

Folder

public Folder()

Default constructor

Folder

public Folder(Long id)

Construct a Folder with specified id

Parameters:

id - Folder id

Method Detail

setName

public Folder setName(String name)

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

Overrides:

setName in class NamedModel<Long>

Parameters:

name - the new name

getPermalink

public String getPermalink()

Gets the Direct URL to Folder.

Returns:

the sheets

setPermalink

public Folder setPermalink(String permalink)

Sets the Direct URL to Folder.

Parameters:

permalink - the new sheets

getFavorite

public Boolean getFavorite()

Gets the favorite boolean value of folder in Home.

Returns:

the sheets

setFavorite

public Folder setFavorite(Boolean favorite)

Sets the favorite boolean value of folder in Home.

Parameters:

favorite - the new sheets

getSheets

public List<Sheet> getSheets()

Gets the sheets in the folder.

Returns:

the sheets

setSheets

public Folder setSheets(List<Sheet> sheets)

Sets the sheets contained in the folder.

Parameters:

sheets - the new sheets

getFolders

public List<Folder> getFolders()

Gets the folders contained in this folder.

Returns:

the folders

setFolders

public Folder setFolders(List<Folder> folders)

Sets the folders contained in this folder.

Parameters:

folders - the new folders

getReports

public List<Report> getReports()

Gets the reports.

Returns:

the reports

setReports

public Folder setReports(List<Report> reports)

Sets the reports.

Parameters:

reports - the new reports

getTemplates

public List<Template> getTemplates()

Gets the templates contained in this folder.

Returns:

the templates

setTemplates

public Folder setTemplates(List<Template> templates)

Sets the templates contained in this folder.

Parameters:

templates - the new templates

getSights

public List<Sight> getSights()

Get the sights contained in this folder

Returns:

the sights

setSights

public Folder setSights(List<Sight> sights)

Sets the sights contained in this folder.

Parameters:

sights -