com.businessobjects.dsws.reportengine
Interface RetrieveNavigationMap

public interface RetrieveNavigationMap

RetrieveNavigationMap is used to retrieve information about the structure of a document. The NavigationMap of the entire document is an array of NavigationNode. The root level contains the reports, all lower levels are associated to sections and sub sections. This model is exposed as a tree.

Example: Retrieve an array of NavigationNode

 RetrieveNavigationMap objRetrieveNavigationMap = RetrieveNavigationMap.Factory.newInstance();
 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 retBOData.setRetrieveNavigationMap(objRetrieveNavigationMap);
 DocumentInformation boDocInfo = boRepEng.getDocumentInformation( strDocid, null, null, null, retBOData);
 NavigationNode[] objNavigationNodes = boDocInfo.getNavigationMapArray();
 for(int i=0;i<objNavigationNodes.length;i++)
 {
    NavigationNode objNavigationNode = objNavigationNodes[i];
    String strName=objNavigationNode.getName();
    out.print(strName);
 }
 

See RetrieveData for an example of how to use the RetrieveData object.

See Also:

com.businessobjects.dsws.reportengine.DocumentInformation#getNavigationMap(), NavigationNode, Navigate, NavigateToDataProvider, NavigateToFirstPage, NavigateToLastPage, NavigateToPage, NavigateToPath, NavigationNode, ReportEngine, BinaryView, XMLView, ViewSupport, ViewModeType, RetrieveData, RetrieveView, OutputFormatType, DocumentInformation

Nested Class Summary

static class

RetrieveNavigationMap.Factory A class with methods for creating instances of the RetrieveNavigationMap type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

int	getDepth() Internal Use Only.
java.lang.String	getPath() Internal Use Only.
void	setDepth(int depth) Sets the depth of the navigation map to retrieve.
void	setPath(java.lang.String path) Sets the path in the Navigation Map to be retrieved.
org.apache.xmlbeans.XmlInt	xgetDepth() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetPath() Internal Use Only.
void	xsetDepth(org.apache.xmlbeans.XmlInt depth) Internal Use Only.
void	xsetPath(org.apache.xmlbeans.XmlString path) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getDepth

int getDepth()

Internal Use Only.

xgetDepth

org.apache.xmlbeans.XmlInt xgetDepth()

Internal Use Only.

setDepth

void setDepth(int depth)

Sets the depth of the navigation map to retrieve.
By setting depth to 0, only one level of the map is retrieved. If the path is set to "", the root level, a array of NavigationNode corresponding to the reports without sections or sub-sections will be returned, without any sections or sub-sections.

Parameters:

depth - depth required.

xsetDepth

void xsetDepth(org.apache.xmlbeans.XmlInt depth)

Internal Use Only.

getPath

java.lang.String getPath()

Internal Use Only.

xgetPath

org.apache.xmlbeans.XmlString xgetPath()

Internal Use Only.

setPath

void setPath(java.lang.String path)

Sets the path in the Navigation Map to be retrieved. The empty string "", corresponds to the root level.

Parameters:

path - the path in the NavigationMap required.

xsetPath

void xsetPath(org.apache.xmlbeans.XmlString path)

Internal Use Only.