Package io.meeds.portal.navigation.service

Interface NavigationConfigurationService

public interface NavigationConfigurationService

  • Method Details

    • getConfiguration

      NavigationConfiguration getConfiguration()
      Returns:
      NavigationConfiguration with the complete configuration of Navigation

    • getConfiguration

      NavigationConfiguration getConfiguration(String username, Locale locale, boolean resolve)
      Parameters:
      username - User name
      locale - Locale to compute Menu item names
      resolve - either resolve name and icon of elements or not
      Returns:
      NavigationConfiguration with the complete configuration of Navigation

    • getTopbarConfiguration

      TopbarConfiguration getTopbarConfiguration(String username, Locale locale)
      Parameters:
      username - User name
      locale - Locale to compute Menu item names
      Returns:
      TopbarConfiguration switch user role and customized settings

    • getSidebarConfiguration

      SidebarConfiguration getSidebarConfiguration(String username, Locale locale)
      Parameters:
      username - User name
      locale - Locale to compute Menu item names
      Returns:
      SidebarConfiguration switch user role and customized settings

    • getSidebarUserMode

      SidebarMode getSidebarUserMode(String username)
      Retrieves the preferred mode of sidebar by a user
      Parameters:
      username - User name as identifier
      Returns:
      preferred SidebarMode or default if not set by user yet

    • updateSidebarUserMode

      void updateSidebarUserMode(String username, SidebarMode mode)
      Updates the preferred mode of sidebar by the user
      Parameters:
      username - User name as identifier
      mode - Preferred SidebarMode by the user

    • updateConfiguration

      void updateConfiguration(NavigationConfiguration navigationConfiguration)
      Updates the Navigation configuration
      Parameters:
      navigationConfiguration -

    • getDefaultTopbarApplications

      List<TopbarApplication> getDefaultTopbarApplications()
      Returns:
      Default Topbar Applications as configured in AddOnService

    • isMetaSiteNavigation

      boolean isMetaSiteNavigation(String siteName)
      Check whether a given site is a meta site navigation

    • isAllowUserHome

      boolean isAllowUserHome()
      Returns:
      true if Users can have personal home URL, else false