Class DefaultNavigationFacade
- java.lang.Object
-
- de.hybris.platform.cmsfacades.navigations.impl.DefaultNavigationFacade
-
- All Implemented Interfaces:
NavigationFacade
public class DefaultNavigationFacade extends java.lang.Object implements NavigationFacade
Default implementation of theNavigationFacade
-
-
Constructor Summary
Constructors Constructor Description DefaultNavigationFacade()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected voidaddAllNavigationNodes(java.util.List<CMSNavigationNodeModel> nodeModels, java.util.List<CMSNavigationNodeModel> navigationNodes)Deprecated, for removal: This API element is subject to removal in a future version.since 1811, please useCMSItemFacade.createItem(Map)instead.NavigationNodeDataaddNavigationNode(NavigationNodeData navigationNodeData)Deprecated, for removal: This API element is subject to removal in a future version.since 1811, please useCMSItemFacade.createItem(Map)instead.voiddeleteNavigationNode(java.lang.String uid)Deprecated, for removal: This API element is subject to removal in a future version.since 1811, please useCMSItemFacade.deleteCMSItemByUuid(String)instead.java.util.List<NavigationNodeData>findAllNavigationNodes()Deprecated, for removal: This API element is subject to removal in a future version.since 1811, please useCMSItemFacade.findCMSItems(CMSItemSearchData, PageableData)instead.java.util.List<NavigationNodeData>findAllNavigationNodes(java.lang.String parentUid)Finds all navigation nodes by parentUid.NavigationNodeDatafindNavigationNodeById(java.lang.String uid)Retrieves aNavigationNodeDataby its item's uid.protected CMSAdminSiteServicegetAdminSiteService()protected java.util.List<NavigationNodeData>getAllNavigationNodes()Deprecated, for removal: This API element is subject to removal in a future version.since 1811, please useCMSItemFacade.findCMSItems(CMSItemSearchData, PageableData)instead.protected org.springframework.validation.ValidatorgetCreateNavigationNodeValidator()protected FacadeValidationServicegetFacadeValidationService()protected ModelServicegetModelService()java.util.List<NavigationNodeData>getNavigationAncestorsAndSelf(java.lang.String navigationNodeUid)Return the node and all of its ancestors.protected NavigationEntryServicegetNavigationEntryService()protected AbstractPopulatingConverter<CMSNavigationNodeModel,NavigationNodeData>getNavigationModelToDataConverter()protected Populator<NavigationNodeData,CMSNavigationNodeModel>getNavigationNodeDataToModelCreatePopulator()protected Populator<NavigationNodeData,CMSNavigationNodeModel>getNavigationNodeDataToModelUpdatePopulator()protected org.springframework.validation.ValidatorgetNavigationNodeEntriesValidator()protected CMSNavigationServicegetNavigationService()protected java.util.List<NavigationNodeData>getRootNavigationNodes()Get the CatalogVersion's navigation nodes.protected org.springframework.transaction.PlatformTransactionManagergetTransactionManager()protected org.springframework.validation.ValidatorgetUpdateNavigationNodeValidator()protected voidpopulateParentNavigationNode(java.util.List<CMSNavigationNodeModel> navigationNodes, CMSNavigationNodeModel node)Recursively add self and parent nodes to the navigationNodes list.voidsetAdminSiteService(CMSAdminSiteService adminSiteService)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer neededvoidsetCreateNavigationNodeValidator(org.springframework.validation.Validator createNavigationNodeValidator)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer neededvoidsetFacadeValidationService(FacadeValidationService facadeValidationService)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer neededvoidsetModelService(ModelService modelService)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer neededvoidsetNavigationEntryService(NavigationEntryService navigationEntryService)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer neededvoidsetNavigationModelToDataConverter(AbstractPopulatingConverter<CMSNavigationNodeModel,NavigationNodeData> navigationModelToDataConverter)voidsetNavigationNodeDataToModelCreatePopulator(Populator<NavigationNodeData,CMSNavigationNodeModel> navigationNodeDataToModelCreatePopulator)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer neededvoidsetNavigationNodeDataToModelUpdatePopulator(Populator<NavigationNodeData,CMSNavigationNodeModel> navigationNodeDataToModelUpdatePopulator)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer neededvoidsetNavigationNodeEntriesValidator(org.springframework.validation.Validator navigationNodeEntriesValidator)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer neededvoidsetNavigationService(CMSNavigationService navigationService)voidsetTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer neededvoidsetUpdateNavigationNodeValidator(org.springframework.validation.Validator updateNavigationNodeValidator)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer neededNavigationNodeDataupdateNavigationNode(java.lang.String navigationNodeUid, NavigationNodeData navigationNodeData)Deprecated, for removal: This API element is subject to removal in a future version.since 1811, please useCMSItemFacade.updateItem(String, Map)instead.
-
-
-
Method Detail
-
findNavigationNodeById
public NavigationNodeData findNavigationNodeById(java.lang.String uid) throws CMSItemNotFoundException
Description copied from interface:NavigationFacadeRetrieves aNavigationNodeDataby its item's uid.- Specified by:
findNavigationNodeByIdin interfaceNavigationFacade- 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) public java.util.List<NavigationNodeData> findAllNavigationNodes()Deprecated, for removal: This API element is subject to removal in a future version.since 1811, please useCMSItemFacade.findCMSItems(CMSItemSearchData, PageableData)instead.Description copied from interface:NavigationFacadeFinds all navigation nodes. Returns a list of all navigation nodes, excluding the root node.- Specified by:
findAllNavigationNodesin interfaceNavigationFacade- Returns:
- a list of
NavigationNodeData
-
findAllNavigationNodes
public java.util.List<NavigationNodeData> findAllNavigationNodes(java.lang.String parentUid)
Description copied from interface:NavigationFacadeFinds 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.- Specified by:
findAllNavigationNodesin interfaceNavigationFacade- Parameters:
parentUid- the parent unique identifier, optional.- Returns:
- a list of
NavigationNodeData
-
getAllNavigationNodes
@Deprecated(since="1811", forRemoval=true) protected java.util.List<NavigationNodeData> getAllNavigationNodes()Deprecated, for removal: This API element is subject to removal in a future version.since 1811, please useCMSItemFacade.findCMSItems(CMSItemSearchData, PageableData)instead.Get all Navigation nodes.- Returns:
- a list of all the navigation nodes data.
-
addAllNavigationNodes
@Deprecated(since="1811", forRemoval=true) protected void addAllNavigationNodes(java.util.List<CMSNavigationNodeModel> nodeModels, java.util.List<CMSNavigationNodeModel> navigationNodes)Deprecated, for removal: This API element is subject to removal in a future version.since 1811, please useCMSItemFacade.createItem(Map)instead.Recursively adds navigation nodes to the reference list- Parameters:
nodeModels- the reference list where all the navigation nodes will be added to.navigationNodes- the navigation nodes starting point
-
getRootNavigationNodes
protected java.util.List<NavigationNodeData> getRootNavigationNodes()
Get the CatalogVersion's navigation nodes.- Returns:
- the root navigation nodes for the current catalog version.
-
updateNavigationNode
@Deprecated(since="1811", forRemoval=true) public NavigationNodeData updateNavigationNode(java.lang.String navigationNodeUid, NavigationNodeData navigationNodeData) throws CMSItemNotFoundExceptionDeprecated, for removal: This API element is subject to removal in a future version.since 1811, please useCMSItemFacade.updateItem(String, Map)instead.Description copied from interface:NavigationFacadeUpdates aNavigationNodeData. 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.- Specified by:
updateNavigationNodein interfaceNavigationFacade- Parameters:
navigationNodeUid- the navigation node unique identifiernavigationNodeData- 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) public NavigationNodeData addNavigationNode(NavigationNodeData navigationNodeData) throws CMSItemNotFoundExceptionDeprecated, for removal: This API element is subject to removal in a future version.since 1811, please useCMSItemFacade.createItem(Map)instead.Description copied from interface:NavigationFacadeCreates a new navigation node represented byNavigationNodeData- Specified by:
addNavigationNodein interfaceNavigationFacade- 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) public void deleteNavigationNode(java.lang.String uid) throws CMSItemNotFoundExceptionDeprecated, for removal: This API element is subject to removal in a future version.since 1811, please useCMSItemFacade.deleteCMSItemByUuid(String)instead.Description copied from interface:NavigationFacadeDeletes a navigation node by item uid.- Specified by:
deleteNavigationNodein interfaceNavigationFacade- Parameters:
uid- the navigation node item Uid to be removed.- Throws:
CMSItemNotFoundException- if the item does not exist
-
getNavigationAncestorsAndSelf
public java.util.List<NavigationNodeData> getNavigationAncestorsAndSelf(java.lang.String navigationNodeUid) throws CMSItemNotFoundException
Description copied from interface:NavigationFacadeReturn the node and all of its ancestors. If the node in question is therootnode, then it returns an empty list.- Specified by:
getNavigationAncestorsAndSelfin interfaceNavigationFacade- Parameters:
navigationNodeUid- the navigation node uid to be returned- Returns:
- a list of
NavigationNodeDatawhere the first element is the node represented by navigationNodeUid - Throws:
CMSItemNotFoundException- - when the navigationNodeUid does not exist.
-
populateParentNavigationNode
protected void populateParentNavigationNode(java.util.List<CMSNavigationNodeModel> navigationNodes, CMSNavigationNodeModel node)
Recursively add self and parent nodes to the navigationNodes list.- Parameters:
navigationNodes- the list containing all navigation nodes.node- the node to be added to the list with its parents.
-
getNavigationService
protected CMSNavigationService getNavigationService()
-
setNavigationService
public void setNavigationService(CMSNavigationService navigationService)
-
getModelService
protected ModelService getModelService()
-
setModelService
@Deprecated(since="1811", forRemoval=true) public void setModelService(ModelService modelService)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer needed
-
getAdminSiteService
protected CMSAdminSiteService getAdminSiteService()
-
setAdminSiteService
@Deprecated(since="1811", forRemoval=true) public void setAdminSiteService(CMSAdminSiteService adminSiteService)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer needed
-
getNavigationModelToDataConverter
protected AbstractPopulatingConverter<CMSNavigationNodeModel,NavigationNodeData> getNavigationModelToDataConverter()
-
setNavigationModelToDataConverter
public void setNavigationModelToDataConverter(AbstractPopulatingConverter<CMSNavigationNodeModel,NavigationNodeData> navigationModelToDataConverter)
-
getNavigationNodeDataToModelUpdatePopulator
protected Populator<NavigationNodeData,CMSNavigationNodeModel> getNavigationNodeDataToModelUpdatePopulator()
-
setNavigationNodeDataToModelUpdatePopulator
@Deprecated(since="1811", forRemoval=true) public void setNavigationNodeDataToModelUpdatePopulator(Populator<NavigationNodeData,CMSNavigationNodeModel> navigationNodeDataToModelUpdatePopulator)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer needed
-
getNavigationNodeDataToModelCreatePopulator
protected Populator<NavigationNodeData,CMSNavigationNodeModel> getNavigationNodeDataToModelCreatePopulator()
-
setNavigationNodeDataToModelCreatePopulator
@Deprecated(since="1811", forRemoval=true) public void setNavigationNodeDataToModelCreatePopulator(Populator<NavigationNodeData,CMSNavigationNodeModel> navigationNodeDataToModelCreatePopulator)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer needed
-
getFacadeValidationService
protected FacadeValidationService getFacadeValidationService()
-
setFacadeValidationService
@Deprecated(since="1811", forRemoval=true) public void setFacadeValidationService(FacadeValidationService facadeValidationService)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer needed
-
getCreateNavigationNodeValidator
protected org.springframework.validation.Validator getCreateNavigationNodeValidator()
-
setCreateNavigationNodeValidator
@Deprecated(since="1811", forRemoval=true) public void setCreateNavigationNodeValidator(org.springframework.validation.Validator createNavigationNodeValidator)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer needed
-
getUpdateNavigationNodeValidator
protected org.springframework.validation.Validator getUpdateNavigationNodeValidator()
-
setUpdateNavigationNodeValidator
@Deprecated(since="1811", forRemoval=true) public void setUpdateNavigationNodeValidator(org.springframework.validation.Validator updateNavigationNodeValidator)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer needed
-
getTransactionManager
protected org.springframework.transaction.PlatformTransactionManager getTransactionManager()
-
setTransactionManager
@Deprecated(since="1811", forRemoval=true) public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer needed
-
getNavigationEntryService
protected NavigationEntryService getNavigationEntryService()
-
setNavigationEntryService
@Deprecated(since="1811", forRemoval=true) public void setNavigationEntryService(NavigationEntryService navigationEntryService)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer needed
-
getNavigationNodeEntriesValidator
protected org.springframework.validation.Validator getNavigationNodeEntriesValidator()
-
setNavigationNodeEntriesValidator
@Deprecated(since="1811", forRemoval=true) public void setNavigationNodeEntriesValidator(org.springframework.validation.Validator navigationNodeEntriesValidator)Deprecated, for removal: This API element is subject to removal in a future version.since 1811 - no longer needed
-
-