Package lumis.portal.structure.sync

Class ChannelResume

  • All Implemented Interfaces:
    IFileElement, IFileStructureElement
    public class ChannelResume
extends java.lang.Object
implements IFileStructureElement
    Resumed information about a channel. Composes a ChannelHierarchy.
    Since:
    6.2.0
    Version:
    $Revision: 26587 $ $Date: 2024-08-26 21:09:17 -0300 (Mon, 26 Aug 2024) $

    • Constructor Detail

      • ChannelResume

        public ChannelResume()

    • Method Detail

      • getId

        public java.lang.String getId()
        Returns this channel's identifier.
        Specified by:
        getId in interface IFileStructureElement
        Returns:
        the identifier.
        Since:
        6.2.0

      • getParentChannel

        public ChannelResume getParentChannel()
        Returns the channel parent of this channel.
        Returns:
        the parent channel.
        Since:
        6.2.0

      • getChannelTemplateLinkInfo

        public ChannelTemplateLinkInfo getChannelTemplateLinkInfo()
        Returns information of the channel template element this channel is linked to.
        Returns:
        the channel template link information.
        Since:
        6.2.0

      • getAccessControlListId

        public java.lang.String getAccessControlListId()
        Returns the identifier of this channel's ACL.
        Returns:
        the ACL identifier.
        Since:
        6.2.0

      • getPropertyBagId

        public java.lang.String getPropertyBagId()
        Returns the identifier of this channel's property bag.
        Returns:
        the property bag identifier.
        Since:
        6.2.0

      • getWebsite

        public IWebsite getWebsite()
        Returns the website this channel belongs to. This property is set by ChannelHierarchy.detectWebsites().
        Returns:
        the website.
        Since:
        6.2.0

      • isKeptUnchanged

        public boolean isKeptUnchanged()
        Returns whether this channel was kept unchanged during a synchronization. Refers only to the corresponding Channel entity, not to any related entity.
        Returns:
        true if it was kept unchanged, false otherwise.
        Since:
        6.2.0

      • keptUnchanged

        public void keptUnchanged()
        Mark this channel as it was kept unchanged.
        Since:
        6.2.0
        See Also:
        isKeptUnchanged()

      • isSelectedForSynchronization

        public boolean isSelectedForSynchronization()
        Returns whether this channel is selected for synchronization. Takes into account selection implied from ancestral channels.
        Returns:
        true if this channel is selected for synchronization, false otherwise.
        Since:
        6.2.0

      • isRecursivelySelectedForSynchronization

        public boolean isRecursivelySelectedForSynchronization()
        Returns whether this channel is selected for recursive synchronization. Takes into account selection implied from ancestral channels.
        Returns:
        true if this channel is selected for recursive synchronization, false otherwise.
        Since:
        6.2.0

      • isKeepParentId

        public boolean isKeepParentId()
        Indicates whether the parent channel id of the related channel should be kept during sync out.
        Returns:
        whether the parent channel id of the related channel should be kept during sync out.
        Since:
        7.1.0

      • isIgnoreOnExportImport

        public boolean isIgnoreOnExportImport()
        Returns whether this channel will be ignored on export and import.
        Returns:
        whether this channel will be ignored on export and import.
        Since:
        8.0.0

      • isIgnoreOnExportImport

        public boolean isIgnoreOnExportImport​(java.util.Map<java.lang.String,​ChannelResume> allChannels)
        Returns whether this channel will be ignored on export and import based on the all channels map.
        Returns:
        whether this channel will be ignored on export and import based on the all channels map.
        Since:
        8.0.0

      • getPath

        public java.lang.String getPath​(boolean isSyncOut)
        Returns the relative path to this channel's directory.
        Parameters:
        isSyncOut - indicates whether is is an export process.
        Returns:
        the path to this channel's directory, relative to the structure root.
        Since:
        7.1.0

      • getStructureFilePath

        public java.lang.String getStructureFilePath​(boolean isSyncOut)
        Returns the relative path to this channel structure file.
        Parameters:
        isSyncOut - indicates whether is is an export process.
        Returns:
        the path to this channel's structure file, relative to the structure root.
        Since:
        7.1.0

      • belongsToComponent

        public boolean belongsToComponent()
        Indicates whether this channel belongs to a component. It belongs to a component if it is a component channel root or a channel descendant of a component channel root.
        Returns:
        true if this channel belongs to a component; false otherwise.
        Since:
        8.0.0

      • getDirectoryChannelId

        public java.lang.String getDirectoryChannelId()
        Description copied from interface: IFileStructureElement
        Returns the identifier of the channel that corresponds to the directory this element's file resides in.
        Specified by:
        getDirectoryChannelId in interface IFileStructureElement
        Returns:
        the identifier of the channel.

      • getStructureFileName

        public java.lang.String getStructureFileName()
        Description copied from interface: IFileStructureElement
        Returns the name of the structure file for this element.
        Specified by:
        getStructureFileName in interface IFileStructureElement
        Returns:
        the structure file name (only the file's name, does not include any path).

      • setFriendlyId

        public void setFriendlyId​(java.lang.String friendlyId)
        Description copied from interface: IFileStructureElement
        Sets the friendly identifier for this structure element.
        Specified by:
        setFriendlyId in interface IFileStructureElement
        Parameters:
        friendlyId - the friendly identifier.

      • getFriendlyId

        public java.lang.String getFriendlyId()

      • isStructureRoot

        public boolean isStructureRoot()
        Returns whether this is a structure's root.
        Returns:
        whether this is a structure's root.
        Since:
        7.1.0

      • findChannelIdsLinkedWithComponentsExcept

        public static java.util.List<java.lang.String> findChannelIdsLinkedWithComponentsExcept​(java.util.Collection<IComponent> components)
        Returns identifiers of channels linked with components, except the ones linked with the specified components.
        Parameters:
        components - the components to not to take into account.
        Returns:
        the channel identifiers.
        Since:
        17.0.0