getWorkspaceTreeAsXML

Syntax

public String getWorkspaceTreeAsXML( long binderId, int levels, String page );

Description

The getWorkspaceTreeAsXML operation returns XML elements needed to construct the requested portion of the Teaming workspace tree.

Parameters and Return Value

binderId

The binder identifier of the starting node of the returned portion of the hierarchy. The top workspace in the Teaming tree has a binder identifier of 1.

levels

The number of hierarchical levels down from the node specified by binderId that you want to include in the returned information. The value -1 indicates that you want all subsequent levels.

page

A parameter used to expand pages of binders. When you specify a valid page identifier, Teaming expands the page by the levels indicated in the levels parameter.

If you do not want to expand pages using this call, pass null as this parameter.

The Web-services overview topic contains more detailed information about working with pages (Section 5.6.6, Binder Pages and search_getWorkspaceTreeAsXML).

return_value

A string containing XML elements needed to construct each node within the requested levels of the workspace hierarchy.

Example

call.setOperationName(new QName("getWorkspaceTreeAsXML")); Object result = call.invoke(new Object[] {new Long(1), new Integer(3), null});

This code returns a string containing XML information for the first three levels of the workspace hierarchy. The following depicts these levels using default workspace titles:

Level 1: Workspaces

     Level 2: Global, Personal, and Team workspaces

          Level 3: Children of Global, Personal, and Team

The children of Global workspaces, Personal workspaces, and Team workspaces can be either workspaces or folders.

See Also