org.hippoecm.hst.configuration.sitemenu
Interface HstSiteMenusConfiguration

All Known Implementing Classes:

HstSiteMenusConfigurationService

public interface HstSiteMenusConfiguration

Implementations should return an unmodifiable map for #getSiteMenuConfiguration() because clients should not be able to modify the configuration

Method Summary

HstSite	getSite() Return the HstSite this HstSiteMap belongs to.
HstSiteMenuConfiguration	getSiteMenuConfiguration(String name)
Map<String,HstSiteMenuConfiguration>	getSiteMenuConfigurations() Returns the map containing all HstSiteMenuConfiguration's and an empty map if there are no HstSiteMenuConfiguration's.

Method Detail

getSite

HstSite getSite()

Return the HstSite this HstSiteMap belongs to.

Returns:

the site this HstSiteMap belongs to

getSiteMenuConfigurations

Map<String,HstSiteMenuConfiguration> getSiteMenuConfigurations()

Returns the map containing all HstSiteMenuConfiguration's and an empty map if there are no HstSiteMenuConfiguration's.

Note: implementation should better return an unmodifiable map to make sure clients cannot modify the map

Returns:

map containing all HstSiteMenuConfiguration's and an empty map if there are no HstSiteMenuConfiguration's

getSiteMenuConfiguration

HstSiteMenuConfiguration getSiteMenuConfiguration(String name)

Parameters:

name - the name of the SiteMenuConfiguration

Returns:

the SiteMenuConfiguration with this name and null if does not exist