Class Folder

    • Constructor Detail

      • Folder

        public Folder()
        Constructor used by JAXB
    • Method Detail

      • getInheritedFrom

        public String getInheritedFrom()
        Name of the node this folder is inherited from
        Returns:
      • setInheritedFrom

        public void setInheritedFrom​(String inheritedFrom)
        sets inherited from
        Parameters:
        inheritedFrom -
      • getInheritedFromId

        public Integer getInheritedFromId()
        Id of the node this folder is inherited from.
        Returns:
      • setInheritedFromId

        public void setInheritedFromId​(Integer inheritedFromId)
        Sets the id of the node from which the folder was inherited from.
        Parameters:
        inheritedFromId -
      • getMasterNode

        public String getMasterNode()
        Name of the node, the master object belongs to
        Returns:
        node name
      • setMasterNode

        public void setMasterNode​(String masterNode)
        Set the name of the node, the master object belongs to
        Parameters:
        masterNode - node name
      • getMasterNodeId

        public Integer getMasterNodeId()
        Return the id of the node, the master object belongs to.
        Returns:
      • setMasterNodeId

        public void setMasterNodeId​(Integer masterNodeId)
        Set the id of the node the master object belongs to.
        Parameters:
        masterNodeId -
      • getMotherId

        public Integer getMotherId()
        Mother id of the folder
        Returns:
        the motherId
      • getPublishDir

        public String getPublishDir()
        Publish directory of the folder
        Returns:
        the publishDir
      • getDescription

        public String getDescription()
        Description
        Returns:
        the description
      • getNodeId

        public Integer getNodeId()
        Node id
        Returns:
        node id
      • isInherited

        public boolean isInherited()
        True if the folder is inherited, false if not
        Returns:
        true if the folder is inherited, false if not
      • getAtposidx

        public String getAtposidx()
        Position of the folder in the folder tree
        Returns:
        position of the folder in the folder tree
      • setMotherId

        public void setMotherId​(Integer motherId)
        Parameters:
        motherId - the motherId to set
      • setPublishDir

        public void setPublishDir​(String publishDir)
        Parameters:
        publishDir - the pubDir to set
      • setDescription

        public void setDescription​(String description)
        Parameters:
        description - the description to set
      • getStartPageId

        public Object getStartPageId()
        ID of the startpage
        Returns:
        startpage id
      • setStartPageId

        public void setStartPageId​(Object startPageId)
        set startpage id
        Parameters:
        startPageId -
      • getTags

        public Map<String,​Tag> getTags()
        Map of object tags of the folder
        Returns:
        the tags
      • setTags

        public void setTags​(Map<String,​Tag> tags)
        Parameters:
        tags - the tags to set
      • getSubfolders

        public List<Folder> getSubfolders()
        List of subfolders
        Returns:
        the subfolders
      • isHasSubfolders

        public boolean isHasSubfolders()
        True if the folder has subfolders (regardless of whether they have been fetched), false if not
        Returns:
        true for folders having subfolders
      • setSubfolders

        public void setSubfolders​(List<Folder> subfolders)
        Parameters:
        subfolders - the subfolders to set
      • setHasSubfolders

        public void setHasSubfolders​(boolean hasSubfolders)
        Set whether the folder has subfolders
        Parameters:
        hasSubfolders - true if the folder has subfolders, false if not
      • setNodeId

        public void setNodeId​(Integer nodeId)
        Set the node id
        Parameters:
        nodeId - node id
      • setInherited

        public void setInherited​(boolean inherited)
        Set whether the folder is inherited
        Parameters:
        inherited - true if the folder is inherited, false if not
      • getPrivileges

        public List<Privilege> getPrivileges()
        Folder privileges
        Returns:
        the folder privileges
      • setPrivileges

        public void setPrivileges​(List<Privilege> privileges)
        Set the folder privileges
        Parameters:
        privileges - Folder privileges
      • getPrivilegeBits

        public String getPrivilegeBits()
        Privilege bits
        Returns:
        privilege bits
      • setPrivilegeBits

        public void setPrivilegeBits​(String privilegeBits)
        Set the privilege bits
        Parameters:
        privilegeBits -
      • getPrivilegeMap

        public PrivilegeMap getPrivilegeMap()
        Map representation of all privileges
        Returns:
        privilege map
      • setPrivilegeMap

        public void setPrivilegeMap​(PrivilegeMap privilegeMap)
        Set the privilege map
        Parameters:
        privilegeMap -
      • setAtposidx

        public void setAtposidx​(String atposidx)
        Set the position of the folder in the folder tree
        Parameters:
        atposidx - position of the folder in the folder tree
      • getPath

        public String getPath()
        Folder path of this folder
        Returns:
        path
      • setPath

        public void setPath​(String path)
        Set the path
        Parameters:
        path - the path
      • getMasterId

        public Integer getMasterId()
        Master ID. The master is the next folder up in the channel hierarchy with the same Channelset ID. The Master ID is 0 if there is no master. Read only.
        Returns:
        Master ID
      • setMasterId

        public void setMasterId​(Integer masterId)
        Sets the Master ID
        Parameters:
        masterId - Master ID
      • getChannelsetId

        public Integer getChannelsetId()
        Channelset ID. All copies of the same folder in different channels share the same Channelset ID. Read only.
        Returns:
        Channelset ID
      • setChannelsetId

        public void setChannelsetId​(Integer channelsetId)
        Sets the Chnanelset ID
        Parameters:
        channelsetId - Channelset ID
      • getChannelId

        public Integer getChannelId()
        Channel ID. It identifies different versions of the same folder in different channels. Equals to the node id for which the folder is defined, or to 0 if it is defined in the topost node of the channel hierarchy. Read only.
        Returns:
        Channel ID
      • setChannelId

        public void setChannelId​(Integer channelId)
        Sets the Channel ID
        Parameters:
        channelId - Channel ID
      • getIsMaster

        public Boolean getIsMaster()
        True if the folder is a master, false otherwise. A folder is a master if it isn't a localized copy of another folder. Read only.
        Returns:
        is_master
      • setIsMaster

        public void setIsMaster​(Boolean isMaster)
        Sets is_master
        Parameters:
        isMaster - is_master
      • getDisinheritedChannels

        public Set<Node> getDisinheritedChannels()
        the set of disinherited channels for this object
        Returns:
        the set of disinherited channels
      • setDisinheritedChannels

        public void setDisinheritedChannels​(Set<Node> disinheritedChannels)
        Set the disinherited channels for this object
        Parameters:
        disinheritedChannels - the set of disinherited channnels
      • isExcluded

        public Boolean isExcluded()
        Whether this folder is excluded from multichannelling.
        Returns:
        true iff the folder should be excluded from multichannelling
      • setExcluded

        public void setExcluded​(Boolean excluded)
        Set wether the folder is excluded from multichannelling
        Parameters:
        excluded - if true, the folder will be excluded from multichannelling
      • isDisinheritDefault

        public Boolean isDisinheritDefault()
        Whether this folder is disinherited by default in new channels.
        Returns:
        true if the folder is disinherited in new channels, false otherwise.
      • setDisinheritDefault

        public void setDisinheritDefault​(Boolean disinheritDefault)
        Set whether this folder should be disinherited by default in new channels.
        Parameters:
        disinheritDefault - If set to true this folder will be disinherited by default in new channels.
      • isDisinherited

        public Boolean isDisinherited()
        True if the folder is disinherited in some channels
        Returns:
        true iff the folder is disinherited
      • setDisinherited

        public void setDisinherited​(Boolean disinherited)
        Set whether the folder is disinherited
        Parameters:
        disinherited - true if disinherited
      • getMeshProject

        public String getMeshProject()
        Mesh Project, this node publishes into. This will only be set for root folders
        Returns:
        mesh project
      • setMeshProject

        public void setMeshProject​(String meshProject)
        Set the mesh project
        Parameters:
        meshProject - mesh project
      • getBreadcrumbs

        public List<BreadcrumbItem> getBreadcrumbs()
        Breadcrums of the folder. The first item is the root folder and the last item the folder itself
        Returns:
        list of breadcrumb items
      • setBreadcrumbs

        public void setBreadcrumbs​(List<BreadcrumbItem> breadcrumbs)
        Set the breadcrumbs
        Parameters:
        breadcrumbs -
      • getNameI18n

        public Map<String,​String> getNameI18n()
        Map of translated names (keys are the language codes)
        Returns:
        name map
      • setNameI18n

        public void setNameI18n​(Map<String,​String> nameI18n)
        Set translated names
        Parameters:
        nameI18n - map of translations
      • getDescriptionI18n

        public Map<String,​String> getDescriptionI18n()
        Map of translated descriptions (keys are the language codes)
        Returns:
        description map
      • setDescriptionI18n

        public void setDescriptionI18n​(Map<String,​String> descriptionI18n)
        Set translated descriptions
        Parameters:
        descriptionI18n - map of translations
      • getPublishDirI18n

        public Map<String,​String> getPublishDirI18n()
        Map of translated publish directories (keys are the language codes)
        Returns:
        publish directory map
      • setPublishDirI18n

        public void setPublishDirI18n​(Map<String,​String> publishDirI18n)
        Set translated publish directories
        Parameters:
        publishDirI18n - map of translations