Package com.smartsheet.api.models

Class Folder

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

    • 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

        @Deprecated(since="3.2.2",
            forRemoval=true)
public java.lang.Boolean getFavorite()
        Deprecated, for removal: This API element is subject to removal in a future version.
        As of API 3.2.2. Please use the isFavorite method in FavoritesResources instead.
        Gets the favorite boolean value of folder in Home.
        Returns:
        the sheets

      • setFavorite

        @Deprecated(since="3.2.2",
            forRemoval=true)
public Folder setFavorite​(java.lang.Boolean favorite)
        Deprecated, for removal: This API element is subject to removal in a future version.
        As of API 3.2.2. Please use the isFavorite method in FavoritesResources instead.
        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.

      • getSource

        public Source getSource()
        Gets the source.
        Returns:
        the source

      • setSource

        public Folder setSource​(Source source)
        Sets the source.
        Parameters:
        source - the source

      • getCreatedAt

        public java.util.Date getCreatedAt()
        Gets the folder creation date.
        Returns:
        the creation date

      • setCreatedAt

        public Folder setCreatedAt​(java.util.Date createdAt)
        Sets the folder creation date.
        Parameters:
        createdAt - the creation date

      • getModifiedAt

        public java.util.Date getModifiedAt()
        Gets the folder last modified date.
        Returns:
        the last modified date

      • setModifiedAt

        public Folder setModifiedAt​(java.util.Date modifiedAt)
        Sets the folder last modified date.
        Parameters:
        modifiedAt - the last modified date