Interface IChannelTreeManager

  • All Known Implementing Classes:
    ChannelTreeManager

    public interface IChannelTreeManager
    Since:
    4.0.0
    Version:
    $Revision: 16037 $ $Date: 2013-11-21 20:58:50 -0200 (Thu, 21 Nov 2013) $
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getBasicData​(SessionConfig sessionConfig, IChannelChildProvider channelChildProvider, java.lang.String channelId, boolean hidePages, boolean hidePageTemplates, boolean hideChannelTemplates, java.lang.String serviceInstancePrimary, 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 primaryServiceInstanceId, ITransaction portalTransaction)
      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 serviceInstanceId, 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.
    • Method Detail

      • getBasicData

        java.lang.String getBasicData​(SessionConfig sessionConfig,
                                      IChannelChildProvider channelChildProvider,
                                      java.lang.String channelId,
                                      boolean hidePages,
                                      boolean hidePageTemplates,
                                      boolean hideChannelTemplates,
                                      ITransaction transaction)
                               throws ManagerException,
                                      PortalException
        Get the basic tree data of the channel. Given a channelId, 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.
        Parameters:
        sessionConfig -
        channelId -
        hidePages -
        hidePageTemplates -
        hideChannelTemplates -
        transaction -
        Returns:
        Returns the list of channel's Id.
        Throws:
        ManagerException
        PortalException
      • getBasicData

        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
        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.
        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
        Since:
        6.1.0
      • getChildrenData

        java.lang.String getChildrenData​(SessionConfig sessionConfig,
                                         IChannelChildProvider channelChildProvider,
                                         java.lang.String channelId,
                                         int hideChannels,
                                         int hidePages,
                                         int hidePageTemplates,
                                         int hideChannelTemplates,
                                         ITransaction transaction)
                                  throws ManagerException,
                                         PortalException
        Get the children's tree data of the channel. Given a channelId, this method returns the immediate children of the channel. To access this method, the user needs the PERMISSION_TYPE_VIEW_CHANNEL permission.
        Parameters:
        sessionConfig -
        channelId -
        hideChannels -
        hidePages -
        hidePageTemplates -
        hideChannelTemplates -
        transaction -
        Returns:
        Returns the channel's Id.
        Throws:
        ManagerException
        PortalException
      • getBasicData

        java.lang.String getBasicData​(SessionConfig sessionConfig,
                                      IChannelChildProvider channelChildProvider,
                                      java.lang.String channelId,
                                      boolean hidePages,
                                      boolean hidePageTemplates,
                                      boolean hideChannelTemplates,
                                      java.lang.String serviceInstancePrimary,
                                      ITransaction transaction)
                               throws ManagerException,
                                      PortalException
        Get the basic tree data of the channel. Given a channelId, 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.
        Parameters:
        sessionConfig -
        channelChildProvider -
        channelId -
        hidePages -
        hidePageTemplates -
        hideChannelTemplates -
        serviceInstancePrimary -
        transaction -
        Returns:
        Throws:
        ManagerException
        PortalException
        Since:
        7.1.0
      • getBasicData

        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 primaryServiceInstanceId,
                                      ITransaction portalTransaction)
                               throws ManagerException,
                                      PortalException
        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.
        Parameters:
        sessionConfig -
        channelChildProvider -
        channelId -
        rootChannelId -
        hidePages -
        hidePageTemplates -
        hideChannelTemplates -
        primaryServiceInstanceId -
        portalTransaction -
        Returns:
        Throws:
        ManagerException
        PortalException
        Since:
        7.1.0
      • getChildrenData

        java.lang.String getChildrenData​(SessionConfig sessionConfig,
                                         IChannelChildProvider channelChildProvider,
                                         java.lang.String channelId,
                                         int hideChannels,
                                         int hidePages,
                                         int hidePageTemplates,
                                         int hideChannelTemplates,
                                         java.lang.String serviceInstanceId,
                                         ITransaction transaction)
                                  throws ManagerException,
                                         PortalException
        Get the children's tree data of the channel. Given a channelId, this method returns the immediate children of the channel. To access this method, the user needs the PERMISSION_TYPE_VIEW_CHANNEL permission.
        Parameters:
        sessionConfig -
        channelId -
        hideChannels -
        hidePages -
        hidePageTemplates -
        hideChannelTemplates -
        serviceInstanceId -
        transaction -
        Returns:
        Returns the channel's Id.
        Throws:
        ManagerException
        PortalException
        Since:
        7.1.0