org.hippoecm.hst.core.sitemapitemhandler

Interface HstSiteMapItemHandlerRegistry

public interface HstSiteMapItemHandlerRegistry

The HstSiteMapItemHandlerRegistry registry interface

Method Summary

Modifier and Type	Method and Description
HstSiteMapItemHandler	getSiteMapItemHandler(HstContainerConfig requestContainerConfig, String siteMapItemHandlerId) Returns the registered HstSiteMapItemHandler.
void	registerSiteMapItemHandler(HstContainerConfig requestContainerConfig, String siteMapItemHandlerId, HstSiteMapItemHandler siteMapItemHandler) Registers the HstSiteMapItemHandler.
void	unregisterAllSiteMapItemHandlers() Unregisters all the SiteMapItemHandlers.
void	unregisterSiteMapItemHandler(HstContainerConfig requestContainerConfig, String siteMapItemHandlerId) Unregister the HstSiteMapItemHandler.

Method Detail

registerSiteMapItemHandler

void registerSiteMapItemHandler(HstContainerConfig requestContainerConfig,
                                String siteMapItemHandlerId,
                                HstSiteMapItemHandler siteMapItemHandler)

Registers the HstSiteMapItemHandler. The key is the pair of container configuration and handle ID.

Parameters:

requestContainerConfig - the container configuration

siteMapItemHandlerId - the siteMapItemHandler ID

siteMapItemHandler -

unregisterSiteMapItemHandler

void unregisterSiteMapItemHandler(HstContainerConfig requestContainerConfig,
                                  String siteMapItemHandlerId)

Unregister the HstSiteMapItemHandler. The key is the pair of container configuration and handle ID.

Parameters:

requestContainerConfig - the container configuration

siteMapItemHandlerId - the handle ID

getSiteMapItemHandler

HstSiteMapItemHandler getSiteMapItemHandler(HstContainerConfig requestContainerConfig,
                                            String siteMapItemHandlerId)

Returns the registered HstSiteMapItemHandler. The key is the pair of container configuration and siteMapItemHandler ID.

Parameters:

requestContainerConfig - the container configuration

siteMapItemHandlerId - the siteMapItemHandler ID

Returns:

the SiteMapItemHandler registered with the key pair.

unregisterAllSiteMapItemHandlers

void unregisterAllSiteMapItemHandlers()

Unregisters all the SiteMapItemHandlers.