Package com.iknowbase.api.presentationservices.model.menu

Interface MenuItemModel

  • public interface MenuItemModel
    A menu item from a menu defined in the repository.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getIndent()
      Returns a blank string suitable for indenting a menu item.
      String getLabel()
      Returns the label of this menu item.
      int getLevel()
      Returns the level of the menu item in the menu tree, starting with 1.
      String getObjectGuid()
      Returns the object id of the menu item.
      int getObjectId()
      Returns the object id of the menu item.
      MenuItemModel getParent()
      Returns the parent of this menu item, or null if this is a top level item.
      boolean isBreadcrumb()
      Returns a flag indicating whether the menu item has been tagged for breadcrumb usage
      boolean isSitemap()
      Returns a flag indicating whether the menu item has been tagged for sitemap usage

    • Method Detail

      • getIndent

        String getIndent()
        Returns a blank string suitable for indenting a menu item.

      • getParent

        MenuItemModel getParent()
        Returns the parent of this menu item, or null if this is a top level item.

      • getLabel

        String getLabel()
        Returns the label of this menu item. The label will typically be the value you want to display to the user. The label is localized to the proper language (as defined by the logged in user, the browser or the domain).

      • getObjectId

        int getObjectId()
        Returns the object id of the menu item. The object id is an integer-based identifier for the object. While the object id is a unique identifier, it should not be used for application purposes, since it may change during the lifetime of an application.

      • getObjectGuid

        String getObjectGuid()
        Returns the object id of the menu item. The object id is an integer-based identifier for the object. The object guid will in general never change, even over time.

      • getLevel

        int getLevel()
        Returns the level of the menu item in the menu tree, starting with 1. Note that the the level represents the actual subset of the menu tree being used. For example, if you define a MenuViewer as starting on the third level of a menu definition, the first menu item rendered will be given level 1.

      • isBreadcrumb

        boolean isBreadcrumb()
        Returns a flag indicating whether the menu item has been tagged for breadcrumb usage

      • isSitemap

        boolean isSitemap()
        Returns a flag indicating whether the menu item has been tagged for sitemap usage