com.businessobjects.dsws.reportengine
Interface Navigate

All Known Subinterfaces:

NavigateToDataProvider, NavigateToFirstPage, NavigateToLastPage, NavigateToPage, NavigateToPath, NavigateToReportPart

public interface Navigate

Navigate interface is used to navigate with in the document.
Navigate is the parent interface for navigation actions such as NavigateToFirstPage which can be performed on the document.
Note: Navigate must not be used on its own. Use interfaces inheriting from Navigate such as NavigateToFirstPage.

Example: Open a document on the last page and retrieve its contents in character HTML format

RetrieveData retBOData = RetrieveData.Factory.newInstance();
RetrieveView retBOView = RetrieveView.Factory.newInstance();
retBOData.setRetrieveView(retBOView);
Navigate nPage = NavigateToLastPage.Factory.newInstance();
DocumentInformation boDocInfo = boRepEng.getDocumentInformation( strDocid, null, null, nPage, retBOData);
CharacterView myBOView = (CharacterView)boDocInfo.getView();
String[] docContents = myBOView.getContent();


See Also:

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

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.