Package lumis.doui.contenttree

Interface IDouiContentTreeManager

  • All Known Implementing Classes:
    DouiContentTreeManager
    public interface IDouiContentTreeManager
    Manager that is used to retrieve information of hierarchical content.
    Since:
    4.0.0
    Version:
    $Revision$ $Date$

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getBasicData​(SessionConfig sessionConfig, java.lang.String interfaceInstanceId, java.lang.String sourceId, java.lang.String currentContentId, boolean useContentKeyAsId, java.lang.String metadataLocale, ITransaction transaction)
      Returns the basic tree data of a content.
      java.lang.String getBasicData​(SessionConfig sessionConfig, java.lang.String interfaceInstanceId, java.lang.String sourceId, java.lang.String currentContentId, java.lang.String metadataLocale, ITransaction transaction)
      Get the basic tree data of the content.
      java.lang.String getChildrenData​(SessionConfig sessionConfig, java.lang.String interfaceInstanceId, java.lang.String sourceId, java.lang.String currentContentId, boolean useContentKeyAsId, java.lang.String metadataLocale, ITransaction transaction)
      Returns the children's tree data of a content.
      java.lang.String getChildrenData​(SessionConfig sessionConfig, java.lang.String interfaceInstanceId, java.lang.String sourceId, java.lang.String currentContentId, java.lang.String metadataLocale, ITransaction transaction)
      Get the children's tree data of the content.

    • Method Detail

      • getBasicData

        java.lang.String getBasicData​(SessionConfig sessionConfig,
                              java.lang.String interfaceInstanceId,
                              java.lang.String sourceId,
                              java.lang.String currentContentId,
                              java.lang.String metadataLocale,
                              ITransaction transaction)
                       throws PortalException
        Get the basic tree data of the content. Given a contentId, this method returns this content immediate children and the immediate children of all the contents in its parent path.
        Parameters:
        sessionConfig -
        interfaceInstanceId -
        sourceId -
        currentContentId -
        transaction -
        Returns:
        a String.
        Throws:
        ManagerException
        PortalException

      • getBasicData

        java.lang.String getBasicData​(SessionConfig sessionConfig,
                              java.lang.String interfaceInstanceId,
                              java.lang.String sourceId,
                              java.lang.String currentContentId,
                              boolean useContentKeyAsId,
                              java.lang.String metadataLocale,
                              ITransaction transaction)
                       throws PortalException
        Returns the basic tree data of a content. Given a contentId, this method returns this content's immediate children and the immediate children of all the contents in its parent path.
        Parameters:
        sessionConfig - user session information.
        interfaceInstanceId - the interface instance identifier.
        sourceId - the content's source identifier.
        currentContentId - the current entry identifier. The identifier type depends on the useContentKeyAsId parameter.
        useContentKeyAsId - true if the entries relationship is based on the Content identifier, false if it is based on the source's primary key field.
        transaction - the transaction.
        Returns:
        a XML containing the information.
        Throws:
        PortalException
        Since:
        7.0.1

      • getChildrenData

        java.lang.String getChildrenData​(SessionConfig sessionConfig,
                                 java.lang.String interfaceInstanceId,
                                 java.lang.String sourceId,
                                 java.lang.String currentContentId,
                                 java.lang.String metadataLocale,
                                 ITransaction transaction)
                          throws PortalException
        Get the children's tree data of the content. Given a contentId, this method returns the immediate children of the content.
        Parameters:
        sessionConfig -
        interfaceInstanceId -
        sourceId -
        currentContentId -
        transaction -
        Returns:
        a String.
        Throws:
        ManagerException
        PortalException

      • getChildrenData

        java.lang.String getChildrenData​(SessionConfig sessionConfig,
                                 java.lang.String interfaceInstanceId,
                                 java.lang.String sourceId,
                                 java.lang.String currentContentId,
                                 boolean useContentKeyAsId,
                                 java.lang.String metadataLocale,
                                 ITransaction transaction)
                          throws PortalException
        Returns the children's tree data of a content. Given a contentId, this method returns the immediate children of the content.
        Parameters:
        sessionConfig - user session information.
        interfaceInstanceId - the interface instance identifier.
        sourceId - the content's source identifier.
        currentContentId - the current entry identifier. The identifier type depends on the useContentKeyAsId parameter.
        useContentKeyAsId - true if the entries relationship is based on the Content identifier, false if it is based on the source's primary key field.
        transaction - the transaction.
        Returns:
        a XML containing the information.
        Throws:
        PortalException
        Since:
        7.0.1