de.hybris.platform.cmswebservices.navigations.controller

Class NavigationController

java.lang.Object

de.hybris.platform.cmswebservices.navigations.controller.NavigationController

public class NavigationController
extends Object

Controller to deal with Navigation Nodes objects

Constructor Summary

Constructors

Constructor and Description
NavigationController()

Method Summary

Modifier and Type	Method and Description
NavigationNodeData	createNavigationNodeById(NavigationNodeData navigationNode, HttpServletRequest request, HttpServletResponse response) Adds a new navigation node
void	deleteNavigationNodeById(String uid) Deletes the navigation node.
NavigationNodeListData	findAllNavigationAncestorsAndSelf(String navigationNodeUid) Finds all navigation ancestors for a given node uid and the node itself.
NavigationNodeListData	findAllNavigationNodes() Finds all navigation nodes
NavigationNodeListData	findAllNavigationNodesByParentUid(String parentUid) Finds all navigation nodes filtering by parentUid
NavigationNodeData	findNavigationNodeById(String uid) Find the navigation node by uid.
protected LocationHeaderResource	getLocationHeaderResource()
protected NavigationFacade	getNavigationFacade()
void	setLocationHeaderResource(LocationHeaderResource locationHeaderResource)
void	setNavigationFacade(NavigationFacade navigationFacade)
NavigationNodeData	updateNavigationNodeById(String uid, NavigationNodeData navigationNode) Updates the navigation node for a given navigation node uid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NavigationController

public NavigationController()

Method Detail

findAllNavigationNodesByParentUid

public NavigationNodeListData findAllNavigationNodesByParentUid(String parentUid)

Finds all navigation nodes filtering by parentUid

Parameters:

parentUid - the parent navigation node Uid

Returns:

a list of navigation nodes

findAllNavigationNodes

public NavigationNodeListData findAllNavigationNodes()

Finds all navigation nodes

Returns:

a list of all navigation nodes, excluding the super root.

findNavigationNodeById

public NavigationNodeData findNavigationNodeById(String uid)
                                          throws CMSItemNotFoundException

Find the navigation node by uid.

Returns:

the navigation node identified by uid.

Throws:

CMSItemNotFoundException - when the Navigation Node has not been found.

updateNavigationNodeById

public NavigationNodeData updateNavigationNodeById(String uid,
                                                   NavigationNodeData navigationNode)
                                            throws CMSItemNotFoundException

Updates the navigation node for a given navigation node uid

Throws:

CMSItemNotFoundException - when the Navigation Node has not been found.

deleteNavigationNodeById

public void deleteNavigationNodeById(String uid)
                              throws CMSItemNotFoundException

Deletes the navigation node.

Throws:

CMSItemNotFoundException - when the Navigation Node has not been found.

createNavigationNodeById

public NavigationNodeData createNavigationNodeById(NavigationNodeData navigationNode,
                                                   HttpServletRequest request,
                                                   HttpServletResponse response)
                                            throws CMSItemNotFoundException

Adds a new navigation node

Parameters:

request - the HttpServletRequest object

response - the HttpServletResponse object

Returns:

the navigation node data created.

Throws:

CMSItemNotFoundException - if the parentUid does not exist

findAllNavigationAncestorsAndSelf

public NavigationNodeListData findAllNavigationAncestorsAndSelf(String navigationNodeUid)
                                                         throws CMSItemNotFoundException

Finds all navigation ancestors for a given node uid and the node itself.

Returns:

the navigation node's ancestors and the node itself.

Throws:

CMSItemNotFoundException - when the navigation node uid does not exist.

getNavigationFacade

protected NavigationFacade getNavigationFacade()

setNavigationFacade

public void setNavigationFacade(NavigationFacade navigationFacade)

getLocationHeaderResource

protected LocationHeaderResource getLocationHeaderResource()

setLocationHeaderResource

public void setLocationHeaderResource(LocationHeaderResource locationHeaderResource)