Package oracle.webcenter.navigationframework

Interface NavigationModel

@Exported public interface NavigationModel
Used to access the navigation model metadata. The object implementing this interface is EL accessible as:
#{navigationContext.defaultNavigationModel}
#{navigationContext.currentNavigationModel}
#{navigationContext.navigationModel['/oracle/webcenter/portalapp/navigations/default-navigation-model']}
Since:
11.1.1.4.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    MODEL_TYPE_LIST
    Parameter value to use to return a List of NavigationResource object
    static final String
    MODEL_TYPE_MENU
    Parameter value to use to return a ChildPropertyMenuModel object
    static final String
    MODEL_TYPE_TREE
    Parameter value to use to return a ChildPropertyTreeModel object
    static final String
    PARAM_EL_DEPTH
    Parameter that defines the initial depth of fetching
    EL: #{navigationContext.defaultNavigationModel.treeModel['depth=1']}
    static final String
    PARAM_EL_INCLUDE_START_NODE
    Parameter that defines whether to include the starting node
    EL: #{navigationContext.defaultNavigationModel.treeModel['includeStartNode=true']}
    static final String
    PARAM_EL_MODEL_TYPE
    Parameter that defines the type of collection you want back as defined by MODEL_TYPE_* constants.
    static final String
    PARAM_EL_PREFETCH_ONLY
    Parameter that defines whether to return nodes up to the depth level requested initially
    EL: #{navigationContext.defaultNavigationModel.treeModel['prefetchOnly=false']}
    static final String
    PARAM_EL_START_NODE
    Parameter that defines the path of the starting node
    EL: #{navigationContext.defaultNavigationModel.treeModel['startNode=home']}

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    evalParamExpr(Map params)
     
    Map<String,String>
    getAttributes()
    Returns a mutable Map of all the NavigationModel attributes
    EL: #{navigationContext.defaultNavigationModel.attributes['Description']}
    NavigationResource
    getCurrentSelection()
    Returns the currently selected NavigationResource
    EL: #{navigationContext.defaultNavigationModel.currentSelection}
    Object
    getDataModel(Map params)
    Returns a collection object representing the navigation based on the Map of parameters passed in.
    List<NavigationResource>
    getDefaultListModel()
    Returns a List with default settings for the navigation model
    EL: #{navigationContext.defaultNavigationModel.defaultListModel}
    org.apache.myfaces.trinidad.model.MenuModel
    getDefaultMenuModel()
    Returns a MenuModel with default settings for the navigation model
    EL: #{navigationContext.defaultNavigationModel.defaultMenuModel}
    String
    getDefaultSiteMap()
    Returns SiteMap XML based on the default settings.
    org.apache.myfaces.trinidad.model.TreeModel
    getDefaultTreeModel()
    Returns a TreeModel with default settings for the navigation model
    EL: #{navigationContext.defaultNavigationModel.defaultTreeModel}
    String
    getMetadataId()
    Returns the id of the NavigationModel object
    String
    getMetadataScope()
    Returns the scope of the NavigationModel object
    List<NavigationResource>
    getPages(Map params)
    Returns the list of visible pages available in the scope that satisfies the includePageStyle and exludePageStyle condition.
    Map<String,Object>
    getProperties()
    Returns an immutable Map of all the NavigationModel default properties
    EL: #{navigationContext.defaultNavigationModel.properties['rootNode']}
    Map<String,Object>
    getProperties(String propertyNames)
    Returns an immutable Map of the NavigationModel properties with names specified in the parameter (in a comma-separated format)
    NavigationResource
    getResource(String resourceId)
    Returns the NavigationResource identified by the resource id.
    List<NavigationResource>
    getResources(PredicateFilter pFilter, String startNode)
    Returns a flattened List of NavigationResource identified by the startNode path and Filter class.
    NavigationResource
    getRootNode()
    Returns the root node of the NavigationModel
    EL: #{navigationContext.defaultNavigationModel.rootNode}
    void
    invalidateCache()
    Invalidates the cache maintains by the NavigationModel object
    void
    setCurrentSelection(NavigationResource navResource)
    Set the NavigationResource as the current selection
    void
    setNewCurrentSelection(String nodePath)
    Update the current selection given the node path

  • Field Details

    • PARAM_EL_START_NODE

      static final String PARAM_EL_START_NODE
      Parameter that defines the path of the starting node
      EL: #{navigationContext.defaultNavigationModel.treeModel['startNode=home']}

      This parameter can be used in combination with other parameters. When used in an EL, comma-separate each parameter. For example, #{navigationContext.defaultNavigationModel.treeModel['startNode=home,includeStartNode=true']}

      See Also:

    • PARAM_EL_INCLUDE_START_NODE

      static final String PARAM_EL_INCLUDE_START_NODE
      Parameter that defines whether to include the starting node
      EL: #{navigationContext.defaultNavigationModel.treeModel['includeStartNode=true']}

      If true, include the starting node, otherwise start from its children. This parameter can be used in combination with other parameters. When used in an EL, comma-separate each parameter. For example, #{navigationContext.defaultNavigationModel.treeModel['startNode=home,includeStartNode=true']}

      See Also:

    • PARAM_EL_DEPTH

      static final String PARAM_EL_DEPTH
      Parameter that defines the initial depth of fetching
      EL: #{navigationContext.defaultNavigationModel.treeModel['depth=1']}

      depth=0 means to fetch the entire tree. This parameter can be used in combination with other parameters. When used in an EL, comma-separate each parameter. For example, #{navigationContext.defaultNavigationModel.treeModel['startNode=home,includeStartNode=true']}

      See Also:

    • PARAM_EL_PREFETCH_ONLY

      static final String PARAM_EL_PREFETCH_ONLY
      Parameter that defines whether to return nodes up to the depth level requested initially
      EL: #{navigationContext.defaultNavigationModel.treeModel['prefetchOnly=false']}

      If true, deeper level nodes can be returned on demand. Use false if you only want the initial sets of nodes. In which case, it doesn't return deeper nodes later on when requested even when there are deeper nodes This parameter can be used in combination with other parameters. When used in an EL, comma-separate each parameter. For example, #{navigationContext.defaultNavigationModel.treeModel['startNode=home,includeStartNode=true']}

      See Also:

    • PARAM_EL_MODEL_TYPE

      static final String PARAM_EL_MODEL_TYPE
      Parameter that defines the type of collection you want back as defined by MODEL_TYPE_* constants. This parameter can be used in combination with other parameters. When used in an EL, comma-separate each parameter. For example, #{navigationContext.defaultNavigationModel.treeModel['startNode=home,includeStartNode=true']}
      See Also:

    • MODEL_TYPE_LIST

      static final String MODEL_TYPE_LIST
      Parameter value to use to return a List of NavigationResource object
      See Also:

    • MODEL_TYPE_TREE

      static final String MODEL_TYPE_TREE
      Parameter value to use to return a ChildPropertyTreeModel object
      See Also:

    • MODEL_TYPE_MENU

      static final String MODEL_TYPE_MENU
      Parameter value to use to return a ChildPropertyMenuModel object
      See Also:

  • Method Details

    • getMetadataScope

      String getMetadataScope()
      Returns the scope of the NavigationModel object
      Returns:

    • getMetadataId

      String getMetadataId()
      Returns the id of the NavigationModel object
      Returns:

    • invalidateCache

      void invalidateCache()
      Invalidates the cache maintains by the NavigationModel object

    • getResource

      NavigationResource getResource(String resourceId) throws ResourceNotFoundException
      Returns the NavigationResource identified by the resource id.
      Parameters:
      resourceId - the resource id can be id-driven path or title-driven path
      Returns:
      Throws:
      ResourceNotFoundException - if no resource matches the resourceId

    • getResources

      List<NavigationResource> getResources(PredicateFilter pFilter, String startNode) throws ResourceNotFoundException
      Returns a flattened List of NavigationResource identified by the startNode path and Filter class.
      Parameters:
      pFilter - the PredicateFilter interface which will be applied to the resource
      startNode - the starting node where we'll get all resources, if NULL will default to root node "/" startNode can be "id" driven or "title" driven.
      Returns:
      collection of NavigationResource Object
      Throws:
      ResourceNotFoundException

    • getRootNode

      NavigationResource getRootNode()
      Returns the root node of the NavigationModel
      EL: #{navigationContext.defaultNavigationModel.rootNode}
      Returns:
      root node

    • getAttributes

      Map<String,String> getAttributes()
      Returns a mutable Map of all the NavigationModel attributes
      EL: #{navigationContext.defaultNavigationModel.attributes['Description']}

      The returned Map implements the entire contract for a modifiable map as described in java.util.Map. These includes put() (to create/update), get() (to read) and, remove() (to delete).

      Returns:
      a mutable Map of all the attributes

    • getProperties

      Map<String,Object> getProperties()
      Returns an immutable Map of all the NavigationModel default properties
      EL: #{navigationContext.defaultNavigationModel.properties['rootNode']}
      Returns:
      an immutable Map of all the default properties

    • getProperties

      Map<String,Object> getProperties(String propertyNames)
      Returns an immutable Map of the NavigationModel properties with names specified in the parameter (in a comma-separated format)
      Returns:
      an immutable Map of all the properties requested

    • setCurrentSelection

      void setCurrentSelection(NavigationResource navResource)
      Set the NavigationResource as the current selection
      Parameters:
      navResource -

    • getCurrentSelection

      NavigationResource getCurrentSelection()
      Returns the currently selected NavigationResource
      EL: #{navigationContext.defaultNavigationModel.currentSelection}
      Returns:
      the currently selected NavigationResource

    • evalParamExpr

      Object evalParamExpr(Map params)

    • getDataModel

      Object getDataModel(Map params)
      Returns a collection object representing the navigation based on the Map of parameters passed in. The parameters are defined by the PARAM_EL_* constants
      Returns:
      a collection object type depending on the PARAM_EL_MODEL_TYPE parameter

    • getDefaultTreeModel

      org.apache.myfaces.trinidad.model.TreeModel getDefaultTreeModel()
      Returns a TreeModel with default settings for the navigation model
      EL: #{navigationContext.defaultNavigationModel.defaultTreeModel}

      The default settings are: startPath = / includeStartNode = true depth = 0 (return whole depth)

      Returns:

    • getDefaultMenuModel

      org.apache.myfaces.trinidad.model.MenuModel getDefaultMenuModel()
      Returns a MenuModel with default settings for the navigation model
      EL: #{navigationContext.defaultNavigationModel.defaultMenuModel}

      The default settings are: startPath = / includeStartNode = true depth = 0 (return whole depth)

      Returns:

    • getDefaultListModel

      List<NavigationResource> getDefaultListModel()
      Returns a List with default settings for the navigation model
      EL: #{navigationContext.defaultNavigationModel.defaultListModel}

      The default settings are: startPath = / includeStartNode = true depth = 0 (return whole depth)

      Returns:

    • getDefaultSiteMap

      String getDefaultSiteMap()
      Returns SiteMap XML based on the default settings. The SiteMap will return a flat list of "navigable" nodes within the navigation model. It won't return entries for items for non-navigable items such as "separators" and "folders".

      The default settings are: startPath = / includeStartNode = true EL: #{navigationContext.defaultNavigationModel.defaultSiteMap}

      Returns:
      site map XML

    • setNewCurrentSelection

      void setNewCurrentSelection(String nodePath)
      Update the current selection given the node path
      Parameters:
      nodePath - node path to the selected resource

    • getPages

      List<NavigationResource> getPages(Map params)
      Returns the list of visible pages available in the scope that satisfies the includePageStyle and exludePageStyle condition. The current scope will be considered if the scope is not passed. This EL returns only the visible pages which uses page styles mentioned in the includePageStyle. And it exclude the pages that uses the page styles mentioned in the excludePageStyle. If includePageStyle and excludePageStyle are empty, then all the visible pages will be returned from the scope. EL: #{navigationContext.defaultNavigationModel. pages['scope=,includePageStyle=<guid1;guid2;guid3>,excludePageStyle=<guid1;guid2>]}

      scope= - Specify the GUID of the scope from where all the pages has to be listed includePageStyle= - Specify the page styles GUID. Pages that uses these page styles needs to be listed. excludePageStyle= - Specify the page styles GUID. Pages that uses these page styles needs to be excluded from the lists

      Parameters:
      params -
      Returns: