com.businessobjects.dsws.reportengine
Interface ViewModeType

public interface ViewModeType

The ViewModeType interface is used to control the way in which you view a document.
You can view:

• An entire document.
• A report within a document.
• A page within a report.
• All DataProviders used to make the document

See ViewSupport for an example of how to use this object.
See ViewSupport to see the relationship between ViewModeType and OutputFormatType.

See Also:

ReportEngine, BinaryView, CharacterView, XMLView, ViewModeType, RetrieveData, RetrieveView, OutputFormatType, DocumentInformation

Nested Class Summary

static class	ViewModeType.Enum Enumeration value class for com.businessobjects.dsws.reportengine.ViewModeType.
static class	ViewModeType.Factory A class with methods for creating instances of the ViewModeType type.

Field Summary

static ViewModeType.Enum	ALL_DATA_PROVIDERS View all DataProviders used to make the document
static ViewModeType.Enum	DATA_PROVIDER View the DataProviders used to make the document
static ViewModeType.Enum	DOCUMENT View entire document.
static int	INT_ALL_DATA_PROVIDERS Returns the int value corresponding to the "DATA_PROVIDERS" ViewModeType
static int	INT_DATA_PROVIDER Returns the int value corresponding to the "DATA_PROVIDER" ViewModeType
static int	INT_DOCUMENT Returns the int value corresponding to the "DOCUMENT" ViewModeType
static int	INT_QUICK_REPORT_PAGE Returns the int value corresponding to the "QUICK_REPORT_PAGE" ViewModeType
static int	INT_REPORT Returns the int value corresponding to the "REPORT" ViewModeType
static int	INT_REPORT_PAGE Returns the int value corresponding to the "REPORT_PAGE" ViewModeType
static int	INT_REPORT_PART Returns the int value corresponding to the "REPORT_PART" ViewModeType
static ViewModeType.Enum	QUICK_REPORT_PAGE View a particular report of the document in Quick Display Mode.
static ViewModeType.Enum	REPORT View a particular report of the document.
static ViewModeType.Enum	REPORT_PAGE View a particular page of the report.
static ViewModeType.Enum	REPORT_PART View a particular part of the report.
static org.apache.xmlbeans.SchemaType	type Internal use only

Method Summary

org.apache.xmlbeans.StringEnumAbstractBase	enumValue() Internal Use Only.
void	set(org.apache.xmlbeans.StringEnumAbstractBase e) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal use only

DOCUMENT

static final ViewModeType.Enum DOCUMENT

View entire document.

REPORT

static final ViewModeType.Enum REPORT

View a particular report of the document.

REPORT_PAGE

static final ViewModeType.Enum REPORT_PAGE

View a particular page of the report.

ALL_DATA_PROVIDERS

static final ViewModeType.Enum ALL_DATA_PROVIDERS

View all DataProviders used to make the document

DATA_PROVIDER

static final ViewModeType.Enum DATA_PROVIDER

View the DataProviders used to make the document

REPORT_PART

static final ViewModeType.Enum REPORT_PART

View a particular part of the report.

QUICK_REPORT_PAGE

static final ViewModeType.Enum QUICK_REPORT_PAGE

View a particular report of the document in Quick Display Mode.

Example: View the document in QUICK_REPORT_PAGE mode

        ViewSupport objViewSupport = ViewSupport.Factory.newInstance();
        objViewSupport.setOutputFormat(OutputFormatType.XML);
        objViewSupport.setViewType(ViewType.XML);
        objViewSupport.setViewMode(ViewModeType.QUICK_REPORT_PAGE);

        RetrieveData retBOData = RetrieveData.Factory.newInstance();
        RetrieveView retBOView = RetrieveView.Factory.newInstance();
        retBOView.setViewSupport(objViewSupport);
        retBOData.setRetrieveView(retBOView);
        DocumentInformation boDocInfo = objReportEngine.getDocumentInformation(docid, null, null, null, retBOData);
        XMLView myBOView = (XMLView)boDocInfo.getView();
        String docContents = myBOView.getContent();
 

INT_DOCUMENT

static final int INT_DOCUMENT

Returns the int value corresponding to the "DOCUMENT" ViewModeType

See Also:

Constant Field Values

INT_REPORT

static final int INT_REPORT

Returns the int value corresponding to the "REPORT" ViewModeType

See Also:

Constant Field Values

INT_REPORT_PAGE

static final int INT_REPORT_PAGE

Returns the int value corresponding to the "REPORT_PAGE" ViewModeType

See Also:

Constant Field Values

INT_ALL_DATA_PROVIDERS

static final int INT_ALL_DATA_PROVIDERS

Returns the int value corresponding to the "DATA_PROVIDERS" ViewModeType

See Also:

Constant Field Values

INT_DATA_PROVIDER

static final int INT_DATA_PROVIDER

Returns the int value corresponding to the "DATA_PROVIDER" ViewModeType

See Also:

Constant Field Values

INT_REPORT_PART

static final int INT_REPORT_PART

Returns the int value corresponding to the "REPORT_PART" ViewModeType

See Also:

Constant Field Values

INT_QUICK_REPORT_PAGE

static final int INT_QUICK_REPORT_PAGE

Returns the int value corresponding to the "QUICK_REPORT_PAGE" ViewModeType

See Also:

Constant Field Values

Method Detail

enumValue

org.apache.xmlbeans.StringEnumAbstractBase enumValue()

Internal Use Only.

set

void set(org.apache.xmlbeans.StringEnumAbstractBase e)

Internal Use Only.