Interface CMSNavigationDao

  • All Known Implementing Classes:
    DefaultCMSNavigationDao

    public interface CMSNavigationDao
    The Interface CMSNavigationDao for finding CMSNavigationNodeModel objects.
    Spring Bean ID:
    cmsNavigationDao
    • Method Detail

      • findRootNavigationNodes

        java.util.List<CMSNavigationNodeModel> findRootNavigationNodes​(java.util.Collection<CatalogVersionModel> catalogVersions)
        Find root navigation nodes by catalog versions.
        Parameters:
        catalogVersions - the catalog versions
        Returns:
        the list of found CMSNavigationNodeModel objects or empty list when not found.
      • findNavigationNodesById

        java.util.List<CMSNavigationNodeModel> findNavigationNodesById​(java.lang.String id,
                                                                       java.util.Collection<CatalogVersionModel> catalogVersions)
        Find navigation nodes by id and catalog versions.
        Parameters:
        id - the id of CMSNavigationNodeModel object to find
        catalogVersions - the collection of catalog versions
        Returns:
        the list of found CMSNavigationNodeModel objects or empty list when not found
      • findNavigationNodesByContentPage

        java.util.List<CMSNavigationNodeModel> findNavigationNodesByContentPage​(ContentPageModel page,
                                                                                java.util.Collection<CatalogVersionModel> catalogVersions)
        Find navigation nodes by content page and catalog versions.
        Parameters:
        page - the page
        catalogVersions - the collection catalog versions
        Returns:
        the list of found CMSNavigationNodeModel objects or empty list when not found
      • findSuperRootNavigationNode

        CMSNavigationNodeModel findSuperRootNavigationNode​(CatalogVersionModel catalogVersion)
        Finds the super navigation root by catalog version.

        Note: CMSNavigationNodeModel are hierarchical structure where the super root is on its top. Beside that the super root is only used as a placeholder for root navigation nodes.

        Parameters:
        catalogVersion - the catalog version
        Returns:
        the super root for given catalog version, or null if not exist
      • findNavigationEntriesByPage

        java.util.List<CMSNavigationEntryModel> findNavigationEntriesByPage​(AbstractPageModel page)
        Finds all CMSNavigationEntryModel whose item attribute is of type AbstractPageModel associated with a AbstractPageModel.
        Parameters:
        page - the page
        Returns:
        a List of CMSNavigationEntryModel, or an empty List CMSNavigationEntryModel if not found
      • findNavigationEntryByUid

        CMSNavigationEntryModel findNavigationEntryByUid​(java.lang.String uid,
                                                         CatalogVersionModel catalogVersion)
        Finds a CMSNavigationEntryModel by uid for a CatalogVersionModel
        Parameters:
        uid - the entry uid
        catalogVersion - the catalog version
        Returns:
        a CMSNavigationEntryModel