Package de.hybris.platform.cms2.servicelayer.services.impl

Class DefaultCMSNavigationService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.cms2.servicelayer.services.impl.AbstractCMSService

de.hybris.platform.cms2.servicelayer.services.impl.DefaultCMSNavigationService

All Implemented Interfaces:

CMSNavigationService, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class DefaultCMSNavigationService
extends AbstractCMSService
implements CMSNavigationService

Default implementation of CMSNavigationService interface.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields inherited from class de.hybris.platform.cms2.servicelayer.services.impl.AbstractCMSService

CURRENTCATALOGVERSION, CURRENTSITE

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor	Description
DefaultCMSNavigationService()

Method Summary

Modifier and Type	Method	Description
void	appendRelatedItems(CMSNavigationNodeModel cmsNavigationNode, Collection<ItemModel> items)	Adds selected items to specific CMSNavigationNodeModel navigation node.
CMSNavigationEntryModel	createCmsNavigationEntry(CatalogVersionModel catalogVersion, ItemModel item)	Creates an orphan entry for a given item.
CMSNavigationEntryModel	createCmsNavigationEntry(CMSNavigationNodeModel node, String entryName, ItemModel entryContent)	Adds a item to given cmsNavigationNode navigation node.
protected CMSNavigationEntryModel	createCmsNavigationEntry(ItemModel entryContent, CatalogVersionModel catalogVersionModel)
CMSNavigationNodeModel	createNavigationNode(ItemModel parentNode, String navigationNodeName, boolean visible, Collection<ItemModel> relatedItems)	Creates a navigation node accordingly to specified attributes.
CMSNavigationNodeModel	createSuperRootNavigationNode(CatalogVersionModel catalogVersion)	Creates super root navigation node for given catalog version.
void	delete(CMSNavigationNodeModel cmsNavigationNode)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811, no longer needed.
protected void	deleteRecursively(CMSNavigationNodeModel cmsNavigationNode)	Deletes all children all way down to leafs.
protected List<ItemModel>	extractCmsNavigationEntries(CMSNavigationNodeModel navigatioNode)	Extracts items from given navigation node.
protected CatalogVersionService	getCatalogVersionService()
protected CMSAdminSiteService	getCmsAdminSiteService()
protected CMSNavigationDao	getCmsNavigationDao()
protected CMSPageService	getCmsPageService()
List<CMSNavigationEntryModel>	getNavigationEntriesByPage(AbstractPageModel page)	Finds all CMSNavigationEntryModel associated with a AbstractPageModel.
Optional<CMSNavigationEntryModel>	getNavigationEntryForId(String id, CatalogVersionModel catalogVersion)	Returns a Navigation Entry identified via its id and the given catalog version
CMSNavigationNodeModel	getNavigationNodeForId(String id)	Returns a Navigation Node identified via its id
protected List<CMSNavigationNodeModel>	getNavigationNodesByContentPage(ContentPageModel page)
List<CMSNavigationNodeModel>	getNavigationNodesForContentPage(ContentPageModel page)	Returns a list of all Navigation Nodes which contain the given page
List<CMSNavigationNodeModel>	getNavigationNodesForContentPageId(String pageId)	Returns a list of all Navigation Nodes which contain the given page
protected KeyGenerator	getProcessCodeGenerator()
List<CMSNavigationNodeModel>	getRootNavigationNodes()
List<CMSNavigationNodeModel>	getRootNavigationNodes(CatalogVersionModel catVer)	Returns all root navigation nodes for given catalog version.
protected List<CMSNavigationNodeModel>	getRootNavigationNodesByContentPage(ContentPageModel page)
List<CMSNavigationNodeModel>	getRootNavigationNodesForContentPage(ContentPageModel page)	Returns a list of all root Navigation Nodes which have this page assigned, or which have a children in their navigation tree which has this page assigned
List<CMSNavigationNodeModel>	getRootNavigationNodesForContentPageId(String pageId)	Returns a list of all root Navigation Nodes which have this page assigned, or which have a children in their navigation tree which has this page assigned
CMSNavigationNodeModel	getSuperRootNavigationNode(CatalogVersionModel catalogVersionModel)	Returns super root navigation node for given catalog version.
boolean	isSuperRootNavigationNode(CMSNavigationNodeModel navigationNodeModel)	Tests if a navigation node is a super root node.
void	move(CMSNavigationNodeModel sourceNode, CMSNavigationNodeModel targetModel)	Moves given nodeModel at last position of the child nodes list of targetModel.
void	move(CMSNavigationNodeModel sourceNode, CMSNavigationNodeModel targetModel, boolean asChild, boolean append)	Moves source nod to targert node.
void	move(CMSNavigationNodeModel cmsNavigationNode, ItemModel sourceEntry, ItemModel targetnEntry)	Moves given items within given navigation node.
void	move(ItemModel item, CMSNavigationNodeModel sourceNode, CMSNavigationNodeModel targetNode)	Moves given item from sourceNode to targetNode.
void	remove(CMSNavigationNodeModel cmsNavigationNode, ItemModel item)	Removes given item from given navigation node.
boolean	removeNavigationEntryByUid(CMSNavigationNodeModel cmsNavigationNode, String navigationEntryUid)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811, no longer needed.
void	setCatalogVersionService(CatalogVersionService catalogVersionService)
void	setCmsAdminSiteService(CMSAdminSiteService cmsAdminSiteService)
void	setCmsNavigationDao(CMSNavigationDao cmsNavigationDao)
void	setCmsPageService(CMSPageService cmsPageService)
void	setProcessCodeGenerator(KeyGenerator keyGenerator)
CMSNavigationNodeModel	setSuperRootNodeOnNavigationNode(CMSNavigationNodeModel navigationNodeModel, CatalogVersionModel catalogVersionModel)	Sets the super root node onto the passed CMS navigation node model.
protected List<CMSNavigationEntryModel>	wrapItemModel(Collection<ItemModel> items, CatalogVersionModel catalogVersionModel)	Wrap given items to become a CMSNavigationEntryModel.

Methods inherited from class de.hybris.platform.cms2.servicelayer.services.impl.AbstractCMSService

getBaseSiteService, getCurrentCatalogVersion, getCurrentSite, getSearchRestrictionService, getUserService, setBaseSiteService, setSearchRestrictionService, setUserService

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultCMSNavigationService

public DefaultCMSNavigationService()

Method Details

getNavigationNodeForId

public CMSNavigationNodeModel getNavigationNodeForId(String id)
                                              throws CMSItemNotFoundException

Returns a Navigation Node identified via its id

Specified by:

getNavigationNodeForId in interface CMSNavigationService

Parameters:

id - id of the Navigation Node

Returns:

The Navigation Node model with the given id

Throws:

CMSItemNotFoundException - if no Navigation Node with the given id could be found

getNavigationNodesByContentPage

protected List<CMSNavigationNodeModel> getNavigationNodesByContentPage(ContentPageModel page)

getNavigationNodesForContentPage

public List<CMSNavigationNodeModel> getNavigationNodesForContentPage(ContentPageModel page)

Returns a list of all Navigation Nodes which contain the given page

Specified by:

getNavigationNodesForContentPage in interface CMSNavigationService

Parameters:

page - Page to lookup

Returns:

list of all Navigation Nodes which have the page assigned

getNavigationNodesForContentPageId

public List<CMSNavigationNodeModel> getNavigationNodesForContentPageId(String pageId)
                                                                throws CMSItemNotFoundException

Returns a list of all Navigation Nodes which contain the given page

Specified by:

getNavigationNodesForContentPageId in interface CMSNavigationService

Parameters:

pageId - id of the page

Returns:

list of all Navigation Nodes which have the page assigned

Throws:

CMSItemNotFoundException - if the page with the given id could not be found

getRootNavigationNodes

public List<CMSNavigationNodeModel> getRootNavigationNodes()

Specified by:

getRootNavigationNodes in interface CMSNavigationService

Returns:

A list of all root navigation nodes in the active catalog version. A root navigation node is defined by not having a parent.

getRootNavigationNodesByContentPage

protected List<CMSNavigationNodeModel> getRootNavigationNodesByContentPage(ContentPageModel page)

getRootNavigationNodesForContentPage

public List<CMSNavigationNodeModel> getRootNavigationNodesForContentPage(ContentPageModel page)

Returns a list of all root Navigation Nodes which have this page assigned, or which have a children in their navigation tree which has this page assigned

Specified by:

getRootNavigationNodesForContentPage in interface CMSNavigationService

Parameters:

page - page to lookup

Returns:

list of all root Navigation Nodes which have this page assigned, or which have a children in their navigation tree which has this page assigned

getRootNavigationNodesForContentPageId

public List<CMSNavigationNodeModel> getRootNavigationNodesForContentPageId(String pageId)
                                                                    throws CMSItemNotFoundException

Returns a list of all root Navigation Nodes which have this page assigned, or which have a children in their navigation tree which has this page assigned

Specified by:

getRootNavigationNodesForContentPageId in interface CMSNavigationService

Parameters:

pageId - id of the page

Returns:

list of all root Navigation Nodes which have this page assigned, or which have a children in their navigation tree which has this page assigned

Throws:

CMSItemNotFoundException - if the page with the given id could not be found

getNavigationEntriesByPage

public List<CMSNavigationEntryModel> getNavigationEntriesByPage(AbstractPageModel page)

Description copied from interface: CMSNavigationService

Finds all CMSNavigationEntryModel associated with a AbstractPageModel.

Specified by:

getNavigationEntriesByPage in interface CMSNavigationService

Parameters:

page - the AbstractPageModel

Returns:

a List of CMSNavigationEntryModel, or an empty List if not found

getNavigationEntryForId

public Optional<CMSNavigationEntryModel> getNavigationEntryForId(String id,
 CatalogVersionModel catalogVersion)

Description copied from interface: CMSNavigationService

Returns a Navigation Entry identified via its id and the given catalog version

Specified by:

getNavigationEntryForId in interface CMSNavigationService

Parameters:

id - id of the Navigation Entry

catalogVersion - catalog version

Returns:

The Navigation Entry model

createCmsNavigationEntry

public CMSNavigationEntryModel createCmsNavigationEntry(CMSNavigationNodeModel node,
 String entryName,
 ItemModel entryContent)

Adds a item to given cmsNavigationNode navigation node.

Note:
This method save all modified models i.e. cmsNavigationNode is saved!

Specified by:

createCmsNavigationEntry in interface CMSNavigationService

Parameters:

node - given navigation node

entryName - the navigation entry name

entryContent - item that will be added

Returns:

the navigation entry model created for the item and navigationNodeModel

createCmsNavigationEntry

public CMSNavigationEntryModel createCmsNavigationEntry(CatalogVersionModel catalogVersion,
 ItemModel item)

Description copied from interface: CMSNavigationService

Creates an orphan entry for a given item.

Note:
This method does not save the entry created.

Specified by:

createCmsNavigationEntry in interface CMSNavigationService

Parameters:

catalogVersion - catalog version

item - item that will be added

Returns:

the navigation entry model created

deleteRecursively

protected void deleteRecursively(CMSNavigationNodeModel cmsNavigationNode)

Deletes all children all way down to leafs.

Parameters:

cmsNavigationNode - navigation node

extractCmsNavigationEntries

protected List<ItemModel> extractCmsNavigationEntries(CMSNavigationNodeModel navigatioNode)

Extracts items from given navigation node.

Parameters:

navigatioNode - given navigation node

wrapItemModel

protected List<CMSNavigationEntryModel> wrapItemModel(Collection<ItemModel> items,
 CatalogVersionModel catalogVersionModel)

Wrap given items to become a CMSNavigationEntryModel.

getRootNavigationNodes

public List<CMSNavigationNodeModel> getRootNavigationNodes(CatalogVersionModel catVer)

Returns all root navigation nodes for given catalog version.

Specified by:

getRootNavigationNodes in interface CMSNavigationService

Parameters:

catVer - catalog version

Returns:

founded root navigation nodes

move

public void move(CMSNavigationNodeModel sourceNode,
 CMSNavigationNodeModel targetModel)

Moves given nodeModel at last position of the child nodes list of targetModel. It is removed from current parent node list of children.

Note:
This method save all modified models i.e. nodeModel and targetModel are saved!

Specified by:

move in interface CMSNavigationService

Parameters:

sourceNode - node that will be moved

targetModel - a new target node

move

public void move(CMSNavigationNodeModel cmsNavigationNode,
 ItemModel sourceEntry,
 ItemModel targetnEntry)

Moves given items within given navigation node. Precisely: Moves given source item to place of target item (target item is moved one position further).

Note:
This method save all modified models i.e. naviNode is saved with new items order!

Specified by:

move in interface CMSNavigationService

Parameters:

cmsNavigationNode - current navigation node

sourceEntry - a source node

targetnEntry - a new target node

move

public void move(ItemModel item,
 CMSNavigationNodeModel sourceNode,
 CMSNavigationNodeModel targetNode)

Moves given item from sourceNode to targetNode. Which means soureNode will have one child less, targetNode on the other hand one more.

Note:
This method save all modified models i.e. sourceNode and targetNode is saved with new item order!

Specified by:

move in interface CMSNavigationService

Parameters:

item - item that will be moved

sourceNode - a source node

targetNode - a new target node

delete

@Deprecated(since="1811",
            forRemoval=true)
public void delete(CMSNavigationNodeModel cmsNavigationNode)

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

since 1811, no longer needed.

Deletes given node and all it' child nodes.

Note:
This method save all modified models!. This method removes only the given navigation node with its child - without other references i.e. pages won't be removed.

Specified by:

delete in interface CMSNavigationService

Parameters:

cmsNavigationNode - navigation node to remove

remove

public void remove(CMSNavigationNodeModel cmsNavigationNode,
 ItemModel item)

Removes given item from given navigation node. The item itself is not deleted.

Note:
This method save all modified models! i.e. cmsNavigationNode is saved!

Specified by:

remove in interface CMSNavigationService

Parameters:

cmsNavigationNode - given navigation node

item - given item to remove from cmsNavigationNode

removeNavigationEntryByUid

@Deprecated(since="1811",
            forRemoval=true)
public boolean removeNavigationEntryByUid(CMSNavigationNodeModel cmsNavigationNode,
 String navigationEntryUid)

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

since 1811, no longer needed.

Removes a given entry from a given navigation node. The Navigation Entry is deleted, but not the ItemModel in the entry.

Note:
This method save all modified models, i.e. cmsNavigationNode is saved.

Specified by:

removeNavigationEntryByUid in interface CMSNavigationService

Parameters:

cmsNavigationNode - given navigation node

navigationEntryUid - given navigation entry uid.

Returns:

true if the entry was removed or false otherwise.

createNavigationNode

public CMSNavigationNodeModel createNavigationNode(ItemModel parentNode,
 String navigationNodeName,
 boolean visible,
 Collection<ItemModel> relatedItems)

Description copied from interface: CMSNavigationService

Creates a navigation node accordingly to specified attributes.

Note:
Returned CMSNavigationNodeModel is not saved!

Specified by:

createNavigationNode in interface CMSNavigationService

Parameters:

parentNode - parent for created navigation node

navigationNodeName - given navigation node name

visible - flag determines navigation node visibility

relatedItems - given related items

Returns:

a new navigation node

isSuperRootNavigationNode

public boolean isSuperRootNavigationNode(CMSNavigationNodeModel navigationNodeModel)

Description copied from interface: CMSNavigationService

Tests if a navigation node is a super root node.

Specified by:

isSuperRootNavigationNode in interface CMSNavigationService

Parameters:

navigationNodeModel - node model to test if it's a super root node

Returns:

returns true if it is a super root node

setSuperRootNodeOnNavigationNode

public CMSNavigationNodeModel setSuperRootNodeOnNavigationNode(CMSNavigationNodeModel navigationNodeModel,
 CatalogVersionModel catalogVersionModel)

Description copied from interface: CMSNavigationService

Sets the super root node onto the passed CMS navigation node model.

Specified by:

setSuperRootNodeOnNavigationNode in interface CMSNavigationService

Parameters:

navigationNodeModel - node model to set the super root node on

catalogVersionModel - the belonging catalog version model of the super root node

Returns:

navigation node with a parent super root node

createSuperRootNavigationNode

public CMSNavigationNodeModel createSuperRootNavigationNode(CatalogVersionModel catalogVersion)

Creates super root navigation node for given catalog version.

Specified by:

createSuperRootNavigationNode in interface CMSNavigationService

Parameters:

catalogVersion - catalog version for which the super root node will be created

Returns:

a new super root navigation node

appendRelatedItems

public void appendRelatedItems(CMSNavigationNodeModel cmsNavigationNode,
 Collection<ItemModel> items)

Description copied from interface: CMSNavigationService

Adds selected items to specific CMSNavigationNodeModel navigation node.

Specified by:

appendRelatedItems in interface CMSNavigationService

Parameters:

cmsNavigationNode - given navigation node

items - that will be added

move

public void move(CMSNavigationNodeModel sourceNode,
 CMSNavigationNodeModel targetModel,
 boolean asChild,
 boolean append)

Description copied from interface: CMSNavigationService

Moves source nod to targert node.

Specified by:

move in interface CMSNavigationService

Parameters:

sourceNode - node to be moved

targetModel - node to be dropped at

asChild - if true source node will be come target node's child otherwise source will become target's sibling

append - if true source will be added as last (child node)/next(sibling) else as first/previous

createCmsNavigationEntry

protected CMSNavigationEntryModel createCmsNavigationEntry(ItemModel entryContent,
 CatalogVersionModel catalogVersionModel)

getSuperRootNavigationNode

public CMSNavigationNodeModel getSuperRootNavigationNode(CatalogVersionModel catalogVersionModel)

Description copied from interface: CMSNavigationService

Returns super root navigation node for given catalog version.

Specified by:

getSuperRootNavigationNode in interface CMSNavigationService

Parameters:

catalogVersionModel - current catalog version

Returns:

a super root navigation node

getCatalogVersionService

protected CatalogVersionService getCatalogVersionService()

setCatalogVersionService

public void setCatalogVersionService(CatalogVersionService catalogVersionService)

getCmsNavigationDao

protected CMSNavigationDao getCmsNavigationDao()

setCmsNavigationDao

public void setCmsNavigationDao(CMSNavigationDao cmsNavigationDao)

getCmsPageService

protected CMSPageService getCmsPageService()

setCmsPageService

public void setCmsPageService(CMSPageService cmsPageService)

getProcessCodeGenerator

protected KeyGenerator getProcessCodeGenerator()

setProcessCodeGenerator

public void setProcessCodeGenerator(KeyGenerator keyGenerator)

getCmsAdminSiteService

protected CMSAdminSiteService getCmsAdminSiteService()

setCmsAdminSiteService

public void setCmsAdminSiteService(CMSAdminSiteService cmsAdminSiteService)