Class File

    • Field Detail

      • fileType

        protected String fileType
        Mimetype of the File
      • description

        protected String description
        Description of the file
      • folderId

        protected Integer folderId
        Id of the folder of the file
      • folderName

        protected String folderName
        the folder name
      • fileSize

        protected Integer fileSize
        Filesize of the file
      • channelId

        protected Object channelId
      • inherited

        protected boolean inherited
        true when the file is inherited from a master channel, false if not
      • tags

        protected Map<String,​Tag> tags
        Tags in the file (objecttags)
      • url

        protected String url
        URL to the file.
      • forceOnline

        protected Boolean forceOnline
        True if the file shall be force to go online, even if nothing depends on it (may be null if status is undetermined).
      • online

        protected boolean online
        True if the file is online (for the node it was fetched for)
      • broken

        protected boolean broken
        True if the file is broken
    • Constructor Detail

      • File

        public File()
        Constructor used by JAXB
    • Method Detail

      • getTypeId

        public Integer getTypeId()
        Type ID
        Returns:
        the typeId
      • setTypeId

        public void setTypeId​(Integer typeId)
      • getInheritedFrom

        public String getInheritedFrom()
        Name of the node, this file was inherited from
        Returns:
      • setInheritedFrom

        public void setInheritedFrom​(String inheritedFrom)
        Sets the name of the node the file was inherited from.
        Parameters:
        inheritedFrom -
      • getInheritedFromId

        public Integer getInheritedFromId()
        Return id of the node, this file was inherited from.
        Returns:
      • setInheritedFromId

        public void setInheritedFromId​(Integer inheritedFromId)
        Set the id of the node this file 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()
        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 -
      • getFolderName

        public String getFolderName()
        Name of the folder of this file
        Returns:
      • setFolderName

        public void setFolderName​(String folderName)
      • getChannelId

        public Object getChannelId()
        Channel ID
        Returns:
      • setChannelId

        public void setChannelId​(Object channelId)
      • getText

        public String getText()
        Name of the file
        Returns:
      • setText

        public void setText​(String text)
      • getLeaf

        public boolean getLeaf()
        This is a file so leaf is true
        Returns:
      • setLeaf

        public void setLeaf​(boolean leaf)
      • getCls

        public String getCls()
        This is a file cls
      • setCls

        public void setCls​(String cls)
      • getIconCls

        public String getIconCls()
        Define attribute to select the appropriate class
        Returns:
      • setIconCls

        public void setIconCls​(String iconCls)
      • getFileType

        public String getFileType()
        File type
        Returns:
        the fileType
      • getDescription

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

        public Integer getFolderId()
        Folder ID
        Returns:
        the folderId
      • getFileSize

        public Integer getFileSize()
        File size
        Returns:
        the fileSize
      • getTags

        public Map<String,​Tag> getTags()
        Map of object tags of this file
        Returns:
      • getUrl

        public String getUrl()
        URL to the file
        Returns:
        the url to the file
      • setLiveUrl

        public void setLiveUrl​(String liveUrl)
        Set the live URL of the page
      • getLiveUrl

        public String getLiveUrl()
        Live URL to the page
        Returns:
      • setPublishPath

        public void setPublishPath​(String publishPath)
        Set the publish path
        Parameters:
        publishPath - publish path
      • getPublishPath

        public String getPublishPath()
        Publish path
        Returns:
        publish path
      • setFileType

        public void setFileType​(String fileType)
        Parameters:
        fileType - the fileType to set
      • setDescription

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

        public void setFolderId​(Integer folderId)
        Parameters:
        folderId - the folderId to set
      • setFileSize

        public void setFileSize​(Integer fileSize)
        Parameters:
        fileSize - the fileSize to set
      • setTags

        public void setTags​(Map<String,​Tag> tags)
      • setUrl

        public void setUrl​(String url)
        Parameters:
        url - the url to the file.
      • isInherited

        public boolean isInherited()
      • setInherited

        public void setInherited​(boolean inherited)
      • getPath

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

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

        public Boolean isForceOnline()
        True if the file shall be force to go online, even if nothing depends on it (may be null if status is undetermined).
        Returns:
        true to force the file online
      • setForceOnline

        public void setForceOnline​(boolean forceOnline)
        Set the force online status
        Parameters:
        forceOnline - new force online status
      • isOnline

        public boolean isOnline()
        True if the file is online, false if it is offline
        Returns:
        online status
      • setOnline

        public void setOnline​(boolean online)
        Set the online status
        Parameters:
        online - online status
      • isBroken

        public boolean isBroken()
        True for broken files
        Returns:
        true for broken
      • setBroken

        public void setBroken​(boolean broken)
        Set the broken status
        Parameters:
        broken - true for broken
      • 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 page is excluded from multichannelling.
        Returns:
        true iff the file should be excluded from multichannelling
      • setExcluded

        public void setExcluded​(Boolean excluded)
        Set wether the file is excluded from multichannelling
        Parameters:
        excluded - if true, the file 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 file is disinherited in some channels
        Returns:
        true iff the file is disinherited
      • setDisinherited

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

        public Folder getFolder()
        Folder of the file
        Returns:
        folder
      • setFolder

        public void setFolder​(Folder folder)
        Set the folder
        Parameters:
        folder - folder
      • getNiceUrl

        public String getNiceUrl()
        Nice URL
        Returns:
        nice URL
      • setNiceUrl

        public void setNiceUrl​(String niceUrl)
        Set the nice URL
        Parameters:
        niceUrl - nice URL
      • getAlternateUrls

        public SortedSet<String> getAlternateUrls()
        Alternate URLs (in alphabetical order)
        Returns:
        sorted alternate URLs
      • setAlternateUrls

        public void setAlternateUrls​(SortedSet<String> alternateUrls)
        Set the alternate URLs
        Parameters:
        alternateUrls - alternate URLs