com.fatwire.services

Interface TreeService

All Superinterfaces:

Service

public interface TreeService
extends Service

The Tree Service is the interface providing tree-related services.

Method Summary

Modifier and Type	Method and Description
List<TreeNodeBean>	getChildren(String loadUrl) Gets All of the immediate children of a node represented by its LoadURL.
List<TreeNodeBean>	getChildren(String loadUrl, int start) Gets All of the immediate children of a node from start represented by its LoadURL.
List<AssetId>	getImmediateChildren(String browseUrl) Gets All of the immediate children of a node represented by its LoadURL.
List<TreeNodeBean>	getRoots(List<String> tabs) Builds a list of tree nodes representing tree tabs.
Map<String,String>	getTreeSections(String tabID) Gets the sections for the given tab id (not fw_uid)
Map<String,String>	getTreeTabs() Returns the tabs available to the specified user in the specified site.

Methods inherited from interface com.fatwire.services.Service

getManager, getResponse, setManager

Method Detail

getTreeTabs

Map<String,String> getTreeTabs()
                        throws ServiceException

Returns the tabs available to the specified user in the specified site.

Returns:

a Map where:

• the key is a String representing the tab fw_uid
• the value is a String representing the tab id

Throws:

ServiceException - wraps any exception underlying the service call.

getTreeSections

Map<String,String> getTreeSections(String tabID)
                            throws ServiceException

Gets the sections for the given tab id (not fw_uid)

Parameters:

tabID - the tab identifier

Returns:

a Map where:

• the key is a String containing the section name
• the value is a String containing the section populate URL

Throws:

ServiceException - wraps any exception underlying the service call.

getRoots

List<TreeNodeBean> getRoots(List<String> tabs)
                     throws ServiceException

Builds a list of tree nodes representing tree tabs.

Parameters:

tabs - the tree tabs for which we want to display root nodes, identified by their fw_uid. If null, returns nodes corresponding to all

Returns:

a code List of code TreeNode objects. see TreeNodeBean

Throws:

ServiceException - wraps any exception underlying the service call.

getImmediateChildren

List<AssetId> getImmediateChildren(String browseUrl)
                            throws ServiceException

Gets All of the immediate children of a node represented by its LoadURL.

Parameters:

browseUrl - a browse url

Returns:

a code List of code TreeNode objects see link TreeNodeBean

Throws:

ServiceException - wraps any exception underlying the service call.

getChildren

List<TreeNodeBean> getChildren(String loadUrl)
                        throws ServiceException

Gets All of the immediate children of a node represented by its LoadURL.

Parameters:

loadUrl - A loadUrl is of the following format: command:label:loadURL A code String representing a node.

Returns:

a code List of code TreeNode objects see link TreeNodeBean

Throws:

ServiceException - wraps any exception underlying the service call.

getChildren

List<TreeNodeBean> getChildren(String loadUrl,
                               int start)
                        throws ServiceException

Gets All of the immediate children of a node from start represented by its LoadURL.

Parameters:

loadUrl - A loadUrl is of the following format: command:label:loadURL A code String representing a node.

start - offset or index of the children node

Returns:

a code List of code TreeNode objects see link TreeNodeBean

Throws:

ServiceException - wraps any exception underlying the service call.