com.businessobjects.rebean.wi
Interface ReportMap

public interface ReportMap

The ReportMap interface exposes the document structure. The root level contains the name of the report sheets and the leaves are associated to sections and sub sections. This model is exposed as a tree.

Method Summary

ReportMapNode	getNodeFromPath(java.lang.String path) Returns the node pointed to by the path.
ReportMapNodes	getStructure() Returns the structure of the report map like a Tree.
void	refresh() Refreshes the ReportMap.

Method Detail

getNodeFromPath

ReportMapNode getNodeFromPath(java.lang.String path)
                              throws REException

Returns the node pointed to by the path.

Parameters:

path - The node path.

Returns:

The node pointed to by the path.

Throws:

REException

getStructure

ReportMapNodes getStructure()

Returns the structure of the report map like a Tree.

Returns:

The reportMapNodes Collection of the first level.

refresh

void refresh()

Refreshes the ReportMap.

Web Intelligence caches the ReportMap for the user. Some editing functionalities may change the ReportMap. It is important to refresh the ReportMap to synchronize the cached user version with the correct version .