com.businessobjects.dsws.reportengine
Interface NavigateToPath

All Superinterfaces:

Navigate

public interface NavigateToPath
extends Navigate

The NavigateToPath interface is used to set the current page of a document to a specific path.

Example:Navigate to the path specified

 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 RetrieveView retBOView = RetrieveView.Factory.newInstance();
 retBOData.setRetrieveView(retBOView);
 NavigateToPath nPath = NavigateToPath.Factory.newInstance();
 //Navigate to the third report of the document, report index starts with "0"
 nPath.setPath("2");
 DocumentInformation docInfo = boRepEng.getDocumentInformation(strDocid,null,null,nPath,retBOData);
 

For an example of how to use the Navigate interfaces see here.

See Also:

Navigate, NavigateToDataProvider, NavigateToFirstPage, NavigateToLastPage, NavigateToPage, NavigateToPath, NavigationNode, ReportEngine, BinaryView, XMLView, ViewSupport, ViewModeType, RetrieveData, RetrieveView, OutputFormatType, DocumentInformation

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

java.lang.String	getPath() Internal Use Only.
void	setPath(java.lang.String path) Sets the current location path to be navigated to.
org.apache.xmlbeans.XmlString	xgetPath() 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

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 current location path to be navigated to.

Parameters:

path - the current location path to be navigated to.

xsetPath

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

Internal Use Only.