de.hybris.platform.cms2.servicelayer.daos

Interface CMSNavigationDao

All Known Implementing Classes:

DefaultCMSNavigationDao

public interface CMSNavigationDao

The Interface CMSNavigationDao for finding CMSNavigationNodeModel objects.

Spring Bean ID:

cmsNavigationDao

Method Summary

Modifier and Type	Method and Description
CMSNavigationNodeModel	findNavigationNodeById(String id, Collection<CatalogVersionModel> catalogVersions) Deprecated. use findNavigationNodesById(String, Collection) instead.
List<CMSNavigationNodeModel>	findNavigationNodesByContentPage(ContentPageModel page, Collection<CatalogVersionModel> catalogVersions) Find navigation nodes by content page and catalog versions.
List<CMSNavigationNodeModel>	findNavigationNodesById(String id, Collection<CatalogVersionModel> catalogVersions) Find navigation nodes by id and catalog versions.
List<CMSNavigationNodeModel>	findRootNavigationNodes(Collection<CatalogVersionModel> catalogVersions) Find root navigation nodes by catalog versions.
CMSNavigationNodeModel	findSuperRootNavigationNode(CatalogVersionModel catalogVersion) Finds the super navigation root by catalog version.

Method Detail

findRootNavigationNodes

List<CMSNavigationNodeModel> findRootNavigationNodes(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.

findNavigationNodeById

@Deprecated
CMSNavigationNodeModel findNavigationNodeById(String id,
                                                          Collection<CatalogVersionModel> catalogVersions)

Deprecated. use findNavigationNodesById(String, Collection) instead.

Find navigation node by id and catalog versions.

Parameters:

id - the id of CMSNavigationNodeModel object to find

catalogVersions - the collection of catalog versions

Returns:

the found CMSNavigationNodeModel object or null when not found

findNavigationNodesById

List<CMSNavigationNodeModel> findNavigationNodesById(String id,
                                                     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

List<CMSNavigationNodeModel> findNavigationNodesByContentPage(ContentPageModel page,
                                                              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