com.businessobjects.rebean.wi
Class ViewModeType

java.lang.Object
  com.businessobjects.rebean.wi.ViewModeType

All Implemented Interfaces:

java.io.Serializable

public final class ViewModeType
extends java.lang.Object
implements java.io.Serializable

The ViewModeType class defines the different modes in which documents and DataProvider may be viewed.

Desktop Intelligence and Web Intelligence documents do not support the same OutputFormatType and ViewModeType combinations. The SupportedViews interface is used to present a Web Intelligence user with the range of views in which it is possible to see a specific document. Each SupportedViews instance contains a collection of SupportedView objects. Each SupportedView instance indicates one format in which it is possible to view a DocumentInstance or DataProvider.

Since:

11.5

See Also:

SupportedView, SupportedViews, DocumentInstance.getSupportedViews(), Serialized Form

Field Summary

static int	_DataProvider The int value of DataProvider.value().
static int	_DataProviders The int value of DataProviders.value().
static int	_Document The int value of Document.value().
static int	_QuickReportPage The int value of QuickReportPage.value()
static int	_Report The int value of Report.value().
static int	_ReportPage The int value of ReportPage.value().
static int	_ReportPart The int value of ReportPart.value().
static ViewModeType	DataProvider View the DataProvider.
static ViewModeType	DataProviders View all DataProviders.
static ViewModeType	Document View the entire document.
static ViewModeType	QuickReportPage View a report in QuickDisplay pagination mode.
static ViewModeType	Report View the individual reports in a DocumentInstance.
static ViewModeType	ReportPage View report pages contained in a DocumentInstance.
static ViewModeType	ReportPart View report parts.

Method Summary

static ViewModeType	from_int(int value) Returns a ViewModeType instance corresponding to value.
java.lang.String	toString() Returns a String representation of this ViewModeType instance.
int	value() Returns the int value corresponding to this ViewModeType instance.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_Report

public static final int _Report

The int value of Report.value().

See Also:

Constant Field Values

Report

public static final ViewModeType Report

View the individual reports in a DocumentInstance.

_ReportPage

public static final int _ReportPage

The int value of ReportPage.value().

See Also:

Constant Field Values

ReportPage

public static final ViewModeType ReportPage

View report pages contained in a DocumentInstance.

_Document

public static final int _Document

The int value of Document.value().

See Also:

Constant Field Values

Document

public static final ViewModeType Document

View the entire document.

_DataProviders

public static final int _DataProviders

The int value of DataProviders.value().

See Also:

Constant Field Values

DataProviders

public static final ViewModeType DataProviders

View all DataProviders.

_DataProvider

public static final int _DataProvider

The int value of DataProvider.value().

See Also:

Constant Field Values

DataProvider

public static final ViewModeType DataProvider

View the DataProvider.

_ReportPart

public static final int _ReportPart

The int value of ReportPart.value().

See Also:

Constant Field Values

_QuickReportPage

public static final int _QuickReportPage

The int value of QuickReportPage.value()

See Also:

Constant Field Values

ReportPart

public static final ViewModeType ReportPart

View report parts.

QuickReportPage

public static final ViewModeType QuickReportPage

View a report in QuickDisplay pagination mode.

See Also:

PaginationMode

Method Detail

value

public int value()

Returns the int value corresponding to this ViewModeType instance.

Returns:

Returns the int value corresponding to this ViewModeType instance.

from_int

public static ViewModeType from_int(int value)

Returns a ViewModeType instance corresponding to value.

Parameters:

value - An int value corresponding to a ViewModeType.

Returns:

A ViewModeType instance.

toString

public java.lang.String toString()

Returns a String representation of this ViewModeType instance.

Note: this method should be used for debugging purposes only.

Overrides:

toString in class java.lang.Object

Returns:

A String representation of this ViewModeType instance.