com.fatwire.gst.foundation.navigation
Interface NavigationService

All Known Implementing Classes:

AbstractNavigationService, SimpleNavigationHelper, WraNavigationService

public interface NavigationService

Since:

August 2012

Author:

Dolf Dijkstra

Method Summary

NavigationNode	getNodeByName(String pagename, int depth)
NavigationNode	getNodeByName(String pagename, int depth, String linkAttribute) Retrieves the NavigationNodes for the Page with the name pagename and in the current site.
NavigationNode	getNodeByName(String site, String pagename, int depth)
NavigationNode	getNodeByName(String site, String pagename, int depth, String linkAttribute)
NavigationNode	getNodeByQuery(com.fatwire.assetapi.query.Query query, int depth, String linkAttribute)
Collection<NavigationNode>	getRootNodesForSite(int depth)
Collection<NavigationNode>	getRootNodesForSite(String site, int depth)
Collection<NavigationNode>	getRootNodesForSite(String site, int depth, String linkAttribute)

Method Detail

getRootNodesForSite

Collection<NavigationNode> getRootNodesForSite(int depth)

Parameters:

depth - the maximum number of levels to retrieve

Returns:

the NavigationNodes for the page by this name.

getRootNodesForSite

Collection<NavigationNode> getRootNodesForSite(String site,
                                               int depth)

Parameters:

site -

depth - the maximum number of levels to retrieve

Returns:

the NavigationNodes for the page by this name.

getRootNodesForSite

Collection<NavigationNode> getRootNodesForSite(String site,
                                               int depth,
                                               String linkAttribute)

Parameters:

site -

depth - the maximum number of levels to retrieve

linkAttribute -

Returns:

getNodeByName

NavigationNode getNodeByName(String pagename,
                             int depth)

Parameters:

pagename - the name of the Page asset

Returns:

the NavigationNode for the page by this name.

getNodeByName

NavigationNode getNodeByName(String site,
                             String pagename,
                             int depth)

Parameters:

site -

pagename - the name of the Page asset

depth - the maximum number of levels to retrieve

Returns:

the NavigationNode for the page by this name.

getNodeByName

NavigationNode getNodeByName(String site,
                             String pagename,
                             int depth,
                             String linkAttribute)

Parameters:

site -

pagename - the name of the Page asset

depth - the maximum number of levels to retrieve

linkAttribute -

Returns:

the NavigationNode for the page by this name.

getNodeByName

NavigationNode getNodeByName(String pagename,
                             int depth,
                             String linkAttribute)

Retrieves the NavigationNodes for the Page with the name pagename and in the current site.

Parameters:

pagename - the name of the Page asset

depth - the maximum number of levels to retrieve

linkAttribute -

Returns:

the NavigationNode for the page by this name.

getNodeByQuery

NavigationNode getNodeByQuery(com.fatwire.assetapi.query.Query query,
                              int depth,
                              String linkAttribute)

Parameters:

query - the asset query, needs to return Page assets

depth - the maximum number of levels to retrieve

linkAttribute -

Returns:

the NavigationNode for the page by this name.