Package de.hybris.platform.cmsfacades.navigations

Interface NavigationFacade

All Known Implementing Classes:

DefaultNavigationFacade

public interface NavigationFacade

Navigation facade interface which deals with methods related to navigation management.

Method Summary

Modifier and Type	Method	Description
NavigationNodeData	addNavigationNode(NavigationNodeData navigationNodeData)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811, please use CMSItemFacade.createItem(Map) instead.
void	deleteNavigationNode(String uid)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811, please use CMSItemFacade.deleteCMSItemByUuid(String) instead.
List<NavigationNodeData>	findAllNavigationNodes()	Deprecated, for removal: This API element is subject to removal in a future version. since 1811, please use CMSItemFacade.findCMSItems(CMSItemSearchData, PageableData) instead.
List<NavigationNodeData>	findAllNavigationNodes(String parentUid)	Finds all navigation nodes by parentUid.
NavigationNodeData	findNavigationNodeById(String uid)	Retrieves a NavigationNodeData by its item's uid.
List<NavigationNodeData>	getNavigationAncestorsAndSelf(String navigationNodeUid)	Return the node and all of its ancestors.
NavigationNodeData	updateNavigationNode(String navigationNodeUid, NavigationNodeData navigationNodeData)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811, please use CMSItemFacade.updateItem(String, Map) instead.

Method Details

findNavigationNodeById

NavigationNodeData findNavigationNodeById(String uid)
                                   throws CMSItemNotFoundException

Retrieves a NavigationNodeData by its item's uid.

Parameters:

uid - The navigation node unique identifier

Returns:

an instance of NavigationNodeData

Throws:

CMSItemNotFoundException - when the item does not exist

findAllNavigationNodes

@Deprecated(since="1811",
            forRemoval=true)
List<NavigationNodeData> findAllNavigationNodes()

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811, please use CMSItemFacade.findCMSItems(CMSItemSearchData, PageableData) instead.

Finds all navigation nodes. Returns a list of all navigation nodes, excluding the root node.

Returns:

a list of NavigationNodeData

findAllNavigationNodes

List<NavigationNodeData> findAllNavigationNodes(String parentUid)

Finds all navigation nodes by parentUid. Returns a list of navigation nodes where the parentUid equals the parentUid parameter, otherwise returns a list of all navigation nodes, excluding the root node. If the parentUid is not an existing item, then it returns an empty list.

Parameters:

parentUid - the parent unique identifier, optional.

Returns:

a list of NavigationNodeData

updateNavigationNode

@Deprecated(since="1811",
            forRemoval=true)
NavigationNodeData updateNavigationNode(String navigationNodeUid,
 NavigationNodeData navigationNodeData)
                                 throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811, please use CMSItemFacade.updateItem(String, Map) instead.

Updates a NavigationNodeData. This method can also be used to move the node to a different tree structure (changing the parentUid), its position in relation to its siblings, the name and title.

Parameters:

navigationNodeUid - the navigation node unique identifier

navigationNodeData - the navigation node data representing the model to be updated.

Returns:

the updated navigation node data.

Throws:

CMSItemNotFoundException - when the item does not exist

addNavigationNode

@Deprecated(since="1811",
            forRemoval=true)
NavigationNodeData addNavigationNode(NavigationNodeData navigationNodeData)
                              throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811, please use CMSItemFacade.createItem(Map) instead.

Creates a new navigation node represented by NavigationNodeData

Parameters:

navigationNodeData - the navigation node value data

Returns:

the navigation node created.

Throws:

CMSItemNotFoundException - if the parentUid does not exist

deleteNavigationNode

@Deprecated(since="1811",
            forRemoval=true)
void deleteNavigationNode(String uid)
                   throws CMSItemNotFoundException

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811, please use CMSItemFacade.deleteCMSItemByUuid(String) instead.

Deletes a navigation node by item uid.

Parameters:

uid - the navigation node item Uid to be removed.

Throws:

CMSItemNotFoundException - if the item does not exist

getNavigationAncestorsAndSelf

List<NavigationNodeData> getNavigationAncestorsAndSelf(String navigationNodeUid)
                                                throws CMSItemNotFoundException

Return the node and all of its ancestors. If the node in question is the root node, then it returns an empty list.

Parameters:

navigationNodeUid - the navigation node uid to be returned

Returns:

a list of NavigationNodeData where the first element is the node represented by navigationNodeUid

Throws:

CMSItemNotFoundException - - when the navigationNodeUid does not exist.