Package com.smartsheet.api.models
Class Workspace
- java.lang.Object
-
- com.smartsheet.api.models.IdentifiableModel<T>
-
- com.smartsheet.api.models.NamedModel<java.lang.Long>
-
- com.smartsheet.api.models.Folder
-
- com.smartsheet.api.models.Workspace
-
public class Workspace extends Folder
Represents the Workspace object which is an area in which sheets, reports, templates and sub-folders can be organized, similar to a folder.- See Also:
- Help Creating a Workspace
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Workspace.UpdateWorkspaceBuilder
A convenience class for creating aWorkspace
object with the appropriate fields for updating a workspace.-
Nested classes/interfaces inherited from class com.smartsheet.api.models.Folder
Folder.CreateFolderBuilder, Folder.UpdateFolderBuilder
-
-
Constructor Summary
Constructors Constructor Description Workspace()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AccessLevel
getAccessLevel()
Gets the user's permissions on a workspace.java.lang.Boolean
getFavorite()
Gets the favoritejava.lang.String
getPermalink()
Gets the permalink to the workspace.Workspace
setAccessLevel(AccessLevel accessLevel)
Sets the user's permissions on a workspace.Folder
setFavorite(java.lang.Boolean favorite)
Sets the favoriteFolder
setPermalink(java.lang.String permalink)
Sets the permalink to the workspace.-
Methods inherited from class com.smartsheet.api.models.Folder
getFolders, getReports, getSheets, getSights, getTemplates, setFolders, setName, setReports, setSheets, setSights, setTemplates
-
Methods inherited from class com.smartsheet.api.models.NamedModel
getName
-
Methods inherited from class com.smartsheet.api.models.IdentifiableModel
equals, getId, hashCode, setId
-
-
-
-
Method Detail
-
getAccessLevel
public AccessLevel getAccessLevel()
Gets the user's permissions on a workspace.- Returns:
- the access level
-
setAccessLevel
public Workspace setAccessLevel(AccessLevel accessLevel)
Sets the user's permissions on a workspace.- Parameters:
accessLevel
- the new access level
-
getPermalink
public java.lang.String getPermalink()
Gets the permalink to the workspace.- Overrides:
getPermalink
in classFolder
- Returns:
- the permalink
-
setPermalink
public Folder setPermalink(java.lang.String permalink)
Sets the permalink to the workspace.- Overrides:
setPermalink
in classFolder
- Parameters:
permalink
- the new permalink
-
getFavorite
public java.lang.Boolean getFavorite()
Gets the favorite- Overrides:
getFavorite
in classFolder
- Returns:
- the favorite
-
setFavorite
public Folder setFavorite(java.lang.Boolean favorite)
Sets the favorite- Overrides:
setFavorite
in classFolder
- Parameters:
favorite
- the favorite
-
-