Package org.hippoecm.frontend.navigation

Interface NavigationItemService

public interface NavigationItemService

Method Summary

Modifier and Type	Method	Description
NavigationItem	getNavigationItem(Session userSession, String pluginClass, Locale locale)	Returns the navigation item for the given plugin class.
List<NavigationItem>	getNavigationItems(Session userSession, Locale locale)	Returns the list of NavigationItems that the logged in user (identified by the userSession) is allowed to see.

Method Detail

getNavigationItems

List<NavigationItem> getNavigationItems(Session userSession,
                                        Locale locale)

Returns the list of NavigationItems that the logged in user (identified by the userSession) is allowed to see.

Parameters:

userSession - jcr session of the logged in user

locale - the locale to use for localizing the displayName of a navigation item.

Returns:

list of navigation items

getNavigationItem

NavigationItem getNavigationItem(Session userSession,
                                 String pluginClass,
                                 Locale locale)

Returns the navigation item for the given plugin class.

Parameters:

userSession - jcr session of the logged in user

pluginClass - fully qualified name of the plugin class that belongs to the returned item.

locale - the locale to use for localizing the displayName of a navigation item.

Returns: