com.ibm.mashups.enabler.model
Interface SharedNavigationModel

All Superinterfaces:
Locator, Model, TreeModel

public SharedNavigationModel
extends TreeModel

Interface for a shared navigation model. This tree model contains a dedicated root node, which holds navigation nodes shared to me by other users. These nodes may have child nodes in case other users shared not only single navigation nodes but whole navigation trees. The shared navigation model is read-only. It may be used only to locate navigation nodes shared by other users. Subscribing to (also referred to as accepting) such navigation nodes is done with the users navigation model.

The shared navigation model supports the following strategies:


Method Summary
 LayoutModel getLayoutModel(NavigationNode node)
           Returns the layout model for the given page.
 Boolean isAccepted(String id)
           Indicates if the shared navigation node is subscribed to, also referred to accepted, or not.
 
Methods inherited from interface com.ibm.mashups.enabler.TreeModel
getRoot, hasChildren, getChildren, getParent
 
Methods inherited from interface com.ibm.mashups.enabler.model.Model
setStrategy, getStrategies, getStrategy, addStrategy, removeStrategy
 
Methods inherited from interface com.ibm.mashups.enabler.Locator
find
 

Method Detail

getLayoutModel

LayoutModel getLayoutModel(NavigationNode node)
Returns the layout model for the given page.

Parameters:
node - the NavigationNode or, if node is a string, the uri of the node for which to return its model. The page must be part of this model. Must not be null.
Returns:
a layout model or null if none exists.

isAccepted

Boolean isAccepted(String id)
Indicates if the shared navigation node is subscribed to, also referred to accepted, or not.

Parameters:
id - of the node. Must not be null.
Returns:
true if the shared navigation node is subscribed to, false if not.


Copyright IBM Corp. 2010 All Rights Reserved.