Package com.smartsheet.api.models

Class Folder

  • Direct Known Subclasses:
    Workspace
    public class Folder
extends NamedModel<java.lang.Long>
    Represents a folder.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class 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 Description
      Folder()
      Default constructor
      Folder​(java.lang.Long id)
      Construct a Folder with specified id

    • Constructor Detail

      • Folder

        public Folder()
        Default constructor

      • Folder

        public Folder​(java.lang.Long id)
        Construct a Folder with specified id
        Parameters:
        id - Folder id

    • Method Detail

      • setName

        public Folder setName​(java.lang.String name)
        Provide an 'override' of setName (returns Folder not NamedModel)
        Overrides:
        setName in class NamedModel<java.lang.Long>
        Parameters:
        name - the new name

      • getPermalink

        public java.lang.String getPermalink()
        Gets the Direct URL to Folder.
        Returns:
        the sheets

      • setPermalink

        public Folder setPermalink​(java.lang.String permalink)
        Sets the Direct URL to Folder.
        Parameters:
        permalink - the new sheets

      • getFavorite

        public java.lang.Boolean getFavorite()
        Gets the favorite boolean value of folder in Home.
        Returns:
        the sheets

      • setFavorite

        public Folder setFavorite​(java.lang.Boolean favorite)
        Sets the favorite boolean value of folder in Home.
        Parameters:
        favorite - the new sheets

      • getSheets

        public java.util.List<Sheet> getSheets()
        Gets the sheets in the folder.
        Returns:
        the sheets

      • setSheets

        public Folder setSheets​(java.util.List<Sheet> sheets)
        Sets the sheets contained in the folder.
        Parameters:
        sheets - the new sheets

      • getFolders

        public java.util.List<Folder> getFolders()
        Gets the folders contained in this folder.
        Returns:
        the folders

      • setFolders

        public Folder setFolders​(java.util.List<Folder> folders)
        Sets the folders contained in this folder.
        Parameters:
        folders - the new folders

      • getReports

        public java.util.List<Report> getReports()
        Gets the reports.
        Returns:
        the reports

      • setReports

        public Folder setReports​(java.util.List<Report> reports)
        Sets the reports.
        Parameters:
        reports - the new reports

      • getTemplates

        public java.util.List<Template> getTemplates()
        Gets the templates contained in this folder.
        Returns:
        the templates

      • setTemplates

        public Folder setTemplates​(java.util.List<Template> templates)
        Sets the templates contained in this folder.
        Parameters:
        templates - the new templates

      • getSights

        public java.util.List<Sight> getSights()
        Get the sights contained in this folder
        Returns:
        the sights

      • setSights

        public Folder setSights​(java.util.List<Sight> sights)
        Sets the sights contained in this folder.