Package lumis.portal.structure.sync

Interface IStructureSyncManager

  • All Known Implementing Classes:
    StructureSyncManager
    public interface IStructureSyncManager
    Provides structure synchronization between the portal database and the file system.
    Since:
    6.2.0
    Version:
    $Revision: 17047 $ $Date: 2015-03-03 11:22:22 -0300 (Tue, 03 Mar 2015) $

    • Method Detail

      • syncIn

        void syncIn​(String rootChannelId,
            Set<String> selectedElements,
            String processId,
            boolean clearHtmlCache)
     throws PortalException
        Synchronizes a structure from the file system to the portal database.
        Parameters:
        rootChannelId - the root of the structure tree to be synchronized.
        selectedElements - the path of the elements, within the tree, selected to be synchronized. A directory selected implies the synchronization of its children. The paths are relative to the structure root (e.g.: "portal/mychannel/pg_mypage.xml").
        processId - the process identifier for progress bar updates.
        clearHtmlCache - indicates whether the HTML cache should be cleared.
        Throws:
        PortalException
        Since:
        6.2.0

      • syncIn

        @Deprecated
void syncIn​(String rootChannelId,
            Set<String> selectedElements,
            String processId,
            File structureRoot,
            boolean clearHtmlCache)
     throws PortalException
        Deprecated.
        since 8.0.0 replaced by syncIn(String, Set, String, IFile, boolean)
        Synchronizes a structure from the file system to the portal database.
        Parameters:
        rootChannelId - the root of the structure tree to be synchronized.
        selectedElements - the path of the elements, within the tree, selected to be synchronized. A directory selected implies the synchronization of its children. The paths are relative to the structure root (e.g.: "portal/mychannel/pg_mypage.xml").
        processId - the process identifier for progress bar updates.
        structureRoot - the directory that is the root of the structure file system to be used.
        clearHtmlCache - indicates whether the HTML cache should be cleared.
        Throws:
        IllegalArgumentException - if the given tructure root couldn't be relativized using the portal known base folders.
        PortalException
        Since:
        6.2.0

      • syncOut

        void syncOut​(String rootChannelId,
             String processId,
             Set<String> globalGroupsToBeExported)
      throws PortalException
        Synchronizes a structure from the portal database to the file system.
        Parameters:
        rootChannelId - the root of the structure tree to be synchronized.
        processId - the process identifier for progress bar updates.
        globalGroupsToBeExported - the identifiers of the global groups that should be exported.
        Throws:
        PortalException
        Since:
        7.1.0

      • syncIn

        void syncIn​(String rootChannelId,
            Set<String> selectedElements,
            String processId,
            IFile structureRoot,
            boolean clearHtmlCache)
     throws PortalException
        Synchronizes a structure from the file system to the portal database.
        Parameters:
        rootChannelId - the root of the structure tree to be synchronized.
        selectedElements - the path of the elements, within the tree, selected to be synchronized. A directory selected implies the synchronization of its children. The paths are relative to the structure root (e.g.: "portal/mychannel/pg_mypage.xml").
        processId - the process identifier for progress bar updates.
        structureRoot - the directory that is the root of the structure file system to be used.
        clearHtmlCache - indicates whether the HTML cache should be cleared.
        Throws:
        PortalException
        Since:
        8.0.0