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

java.util.List<TreeNodeBean>	getChildren(java.lang.String loadUrl, java.lang.String op, int start, boolean showParents) Gets All of the immediate children of a node represented by its LoadURL.
java.util.List<AssetId>	getImmediateChildren(java.lang.String browseUrl) Gets All of the immediate children of a node represented by its LoadURL.
java.util.List<TreeNodeBean>	getRoots(java.util.List<java.lang.String> tabs) Builds a list of tree nodes representing tree tabs.
java.util.Map<java.lang.String,java.lang.String>	getTreeSections(java.lang.String tabID) Gets the sections for the given tab id (not fw_uid)
java.util.Map<java.lang.String,java.lang.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

java.util.Map<java.lang.String,java.lang.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

java.util.Map<java.lang.String,java.lang.String> getTreeSections(java.lang.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

java.util.List<TreeNodeBean> getRoots(java.util.List<java.lang.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 tree tabs accessible by the current user.

browse - The browse execute feature enabled. In essence true to browse parent tree nodes passed in from client

Returns:

a List of TreeNode objects.

Throws:

ServiceException - wraps any exception underlying the service call.

See Also:

TreeNodeBean}

getChildren

java.util.List<TreeNodeBean> getChildren(java.lang.String loadUrl,
                                         java.lang.String op,
                                         int start,
                                         boolean showParents)
                                         throws ServiceException

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

Parameters:

loadUrl - A String representing a node.

A loadUrl is of the following format:

 command:label:loadURL 
 

Returns:

a List of TreeNode objects

Throws:

ServiceException - wraps any exception underlying the service call.

See Also:

TreeNodeBean}

getImmediateChildren

java.util.List<AssetId> getImmediateChildren(java.lang.String browseUrl)
                                             throws ServiceException

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

Parameters:

loadUrl - A String representing a node.

A loadUrl is of the following format:

 command:label:loadURL 
 

Returns:

a List of TreeNode objects

Throws:

ServiceException - wraps any exception underlying the service call.

See Also:

TreeNodeBean}