Interface IChannelTreeDao

  • All Known Implementing Classes:
    ChannelTreeDaoJdbc

    public interface IChannelTreeDao
    Dao interface for channel tree.
    Since:
    4.0.0
    Version:
    $Revision: 19931 $ $Date: 2017-02-16 13:06:03 -0200 (Thu, 16 Feb 2017) $
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.util.List<lumis.portal.channel.tree.Channel>> getBasicData​(java.lang.String channelId, boolean hideChannelTemplates, java.lang.String primaryServiceInstanceId, ITransaction transaction)
      Get the basic tree data of the channel considering area tags from each channel.
      java.util.Map<java.lang.String,​java.util.List<lumis.portal.channel.tree.Channel>> getBasicData​(java.lang.String channelId, boolean hideChannelTemplates, ITransaction transaction)
      Get the basic tree data of the channel.
      java.util.Map<java.lang.String,​java.util.List<lumis.portal.channel.tree.Channel>> getBasicDataWithAreaTags​(java.lang.String channelId, java.lang.String rootChannelId, boolean hideChannelTemplates, java.util.Collection<java.lang.String> areaTags, ITransaction transaction)
      Get the basic tree data of the channel (with a given root channel) considering area tags from each child channels.
      java.util.Map<java.lang.String,​java.util.List<lumis.portal.channel.tree.Channel>> getBasicDataWithRootChannel​(java.lang.String channelId, java.lang.String rootChannelId, boolean hideChannelTemplates, ITransaction transaction)
      Get the basic tree data of the channel (with a given root channel).
      org.json.simple.JSONArray getChannelChildren​(java.lang.String channelId, ITransaction transaction)  
      org.json.simple.JSONObject getChannelTree​(java.lang.String channelId, boolean includeParents, boolean localizeNames, ITransaction transaction)  
      java.util.Map<java.lang.String,​java.util.List<lumis.portal.channel.tree.Channel>> getChildrenData​(java.lang.String channelId, int hideChannels, int hidePages, int hidePageTemplates, int hideChannelTemplates, ITransaction transaction)
      Get the tree childen's data of the channel.
    • Method Detail

      • getBasicData

        java.util.Map<java.lang.String,​java.util.List<lumis.portal.channel.tree.Channel>> getBasicData​(java.lang.String channelId,
                                                                                                             boolean hideChannelTemplates,
                                                                                                             ITransaction transaction)
                                                                                                      throws DaoException,
                                                                                                             PortalException
        Get the basic tree data of the channel. This method returns all the parents (entire ancestry) of the given channel. This is the minimum information required to render a channel within its tree.
        Parameters:
        channelId -
        hideChannelTemplates -
        transaction -
        Returns:
        Throws:
        DaoException
        PortalException
      • getChildrenData

        java.util.Map<java.lang.String,​java.util.List<lumis.portal.channel.tree.Channel>> getChildrenData​(java.lang.String channelId,
                                                                                                                int hideChannels,
                                                                                                                int hidePages,
                                                                                                                int hidePageTemplates,
                                                                                                                int hideChannelTemplates,
                                                                                                                ITransaction transaction)
                                                                                                         throws DaoException,
                                                                                                                PortalException
        Get the tree childen's data of the channel.
        Parameters:
        channelId -
        hideChannels -
        hidePages -
        hidePageTemplates -
        hideChannelTemplates -
        transaction -
        Returns:
        Throws:
        DaoException
        PortalException
      • getBasicDataWithRootChannel

        java.util.Map<java.lang.String,​java.util.List<lumis.portal.channel.tree.Channel>> getBasicDataWithRootChannel​(java.lang.String channelId,
                                                                                                                            java.lang.String rootChannelId,
                                                                                                                            boolean hideChannelTemplates,
                                                                                                                            ITransaction transaction)
                                                                                                                     throws PortalException
        Get the basic tree data of the channel (with a given root channel). This method returns all the parents (entire ancestry) of the given channel. This is the minimum information required to render a channel within its tree.
        Parameters:
        channelId - the channel id.
        rootChannelId - the root channel id.
        hideChannelTemplates - hides the channel templates.
        transaction - the transaction to be used.
        Returns:
        the basic tree data of the channel (with a given root channel)
        Throws:
        PortalException
        Since:
        6.1.0
      • getBasicData

        java.util.Map<java.lang.String,​java.util.List<lumis.portal.channel.tree.Channel>> getBasicData​(java.lang.String channelId,
                                                                                                             boolean hideChannelTemplates,
                                                                                                             java.lang.String primaryServiceInstanceId,
                                                                                                             ITransaction transaction)
                                                                                                      throws DaoException,
                                                                                                             PortalException
        Get the basic tree data of the channel considering area tags from each channel. This method returns all the parents (entire ancestry) of the given channel. This is the minimum information required to render a channel within its tree.
        Parameters:
        channelId - the current channel id.
        hideChannelTemplates - if is to hide or not channel templates.
        serviceInstancePrimary - the service instance that have the channel the area tags that will define witch channel will be returned.
        transaction - the transaction to be used during the process.
        Returns:
        the basic tree data of the channel considering area tags from each channel.
        Throws:
        DaoException - if any error occurs during the data base query.
        PortalException - if any other error occurs during the process.
        Since:
        7.1.0
      • getBasicDataWithAreaTags

        java.util.Map<java.lang.String,​java.util.List<lumis.portal.channel.tree.Channel>> getBasicDataWithAreaTags​(java.lang.String channelId,
                                                                                                                         java.lang.String rootChannelId,
                                                                                                                         boolean hideChannelTemplates,
                                                                                                                         java.util.Collection<java.lang.String> areaTags,
                                                                                                                         ITransaction transaction)
                                                                                                                  throws PortalException
        Get the basic tree data of the channel (with a given root channel) considering area tags from each child channels. This method returns all the parents (entire ancestry) of the given channel. This is the minimum information required to render a channel within its tree.
        Parameters:
        channelId - the current channel id.
        rootChannelId - the root channel that will be used as reference to start the query.
        hideChannelTemplates - if is to hide or not channel templates.
        areaTags - the list of area tags that the channels must have (at least one) to be returned.
        transaction - the transaction to be used during the process.
        Returns:
        Get the basic tree data of the channel (with a given root channel) considering area tags from each child channels.
        Throws:
        PortalException - if any other error occurs during the process.
        Since:
        7.1.0