Class ChannelTreeManager

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addChannels​(java.lang.StringBuilder result, java.lang.StringBuilder parentChannelIds, java.util.Map<java.lang.String,​java.util.List<lumis.portal.channel.tree.Channel>> channelChildren, ILocalizationManager localizationManager, IResource resource, SessionConfig sessionConfig, java.lang.String primaryServiceInstanceId, ITransaction transaction)  
      protected void addPages​(java.lang.StringBuilder result, java.util.List<IChannelChild> children, SessionConfig sessionConfig, ITransaction transaction)  
      java.lang.String getBasicData​(SessionConfig sessionConfig, IChannelChildProvider channelChildProvider, java.lang.String channelId, boolean hidePages, boolean hidePageTemplates, boolean hideChannelTemplates, java.lang.String primaryServiceInstance, ITransaction transaction)
      Get the basic tree data of the channel.
      java.lang.String getBasicData​(SessionConfig sessionConfig, IChannelChildProvider channelChildProvider, java.lang.String channelId, boolean hidePages, boolean hidePageTemplates, boolean hideChannelTemplates, ITransaction transaction)
      Get the basic tree data of the channel.
      java.lang.String getBasicData​(SessionConfig sessionConfig, IChannelChildProvider channelChildProvider, java.lang.String channelId, java.lang.String rootChannelId, boolean hidePages, boolean hidePageTemplates, boolean hideChannelTemplates, java.lang.String primaryServiceInstance, ITransaction transaction)
      Get the basic tree data of the channel.
      java.lang.String getBasicData​(SessionConfig sessionConfig, IChannelChildProvider channelChildProvider, java.lang.String channelId, java.lang.String rootChannelId, boolean hidePages, boolean hidePageTemplates, boolean hideChannelTemplates, ITransaction portalTransaction)
      Get the basic tree data of the channel.
      java.lang.String getChildrenData​(SessionConfig sessionConfig, IChannelChildProvider channelChildProvider, java.lang.String channelId, int hideChannels, int hidePages, int hidePageTemplates, int hideChannelTemplates, java.lang.String primaryServiceInstanceId, ITransaction transaction)
      Get the children's tree data of the channel.
      java.lang.String getChildrenData​(SessionConfig sessionConfig, IChannelChildProvider channelChildProvider, java.lang.String channelId, int hideChannels, int hidePages, int hidePageTemplates, int hideChannelTemplates, ITransaction transaction)
      Get the children's tree data of the channel.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ChannelTreeManager

        public ChannelTreeManager()
    • Method Detail

      • getBasicData

        public java.lang.String getBasicData​(SessionConfig sessionConfig,
                                             IChannelChildProvider channelChildProvider,
                                             java.lang.String channelId,
                                             java.lang.String rootChannelId,
                                             boolean hidePages,
                                             boolean hidePageTemplates,
                                             boolean hideChannelTemplates,
                                             java.lang.String primaryServiceInstance,
                                             ITransaction transaction)
                                      throws ManagerException,
                                             PortalException
        Description copied from interface: IChannelTreeManager
        Get the basic tree data of the channel. Given a channelId and a root channel id, this method returns this channels immediate children and the immediate children of all the channels in its parent path. To access this method, the user needs the PERMISSION_TYPE_VIEW_CHANNEL permission.
        Specified by:
        getBasicData in interface IChannelTreeManager
        Returns:
        Throws:
        ManagerException
        PortalException
      • addChannels

        protected void addChannels​(java.lang.StringBuilder result,
                                   java.lang.StringBuilder parentChannelIds,
                                   java.util.Map<java.lang.String,​java.util.List<lumis.portal.channel.tree.Channel>> channelChildren,
                                   ILocalizationManager localizationManager,
                                   IResource resource,
                                   SessionConfig sessionConfig,
                                   java.lang.String primaryServiceInstanceId,
                                   ITransaction transaction)
                            throws PortalException
        Throws:
        PortalException
      • getBasicData

        public java.lang.String getBasicData​(SessionConfig sessionConfig,
                                             IChannelChildProvider channelChildProvider,
                                             java.lang.String channelId,
                                             java.lang.String rootChannelId,
                                             boolean hidePages,
                                             boolean hidePageTemplates,
                                             boolean hideChannelTemplates,
                                             ITransaction portalTransaction)
                                      throws ManagerException,
                                             PortalException
        Description copied from interface: IChannelTreeManager
        Get the basic tree data of the channel. Given a channelId and a root channel id, this method returns this channels immediate children and the immediate children of all the channels in its parent path. To access this method, the user needs the PERMISSION_TYPE_VIEW_CHANNEL permission.
        Specified by:
        getBasicData in interface IChannelTreeManager
        Parameters:
        sessionConfig - the user's session.
        channelChildProvider - the channel child provider.
        channelId - the channel id.
        rootChannelId - the root channel id.
        hidePages - hides pages.
        hidePageTemplates - hides page templates.
        hideChannelTemplates - hides channel templates.
        portalTransaction - the transaction.
        Returns:
        the basic tree data of the channel
        Throws:
        ManagerException
        PortalException