com.businessobjects.dsws.reportengine
Interface View

All Known Subinterfaces:

BinaryView, CharacterView, XMLView

public interface View

The View interface is the parent interface for all possible data formats returned by the DocumentInformation object.

See Also:

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

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal use only

Method Summary

ReportPart	addNewReportPart() Internal Use Only.
ViewSupport	addNewViewSupport() Internal Use Only.
int	getChunkSize() Returns the total size of the document view expressed in bytes for binary views and the total size of the document view expressed in characters for other kinds of views.
int	getContentLength() Returns: the total size of the document view expressed in bytes for binary views, the total size of the document view expressed in characters for other kinds of views.
boolean	getLastChunk() Returns true, if the view object is the last chunk of the document view.
ReportPart[]	getReportPartArray() Gets a particular part of the report.
ReportPart	getReportPartArray(int i) Gets a part of the particular index within a report.
ViewSupport	getViewSupport() Returns a ViewSupport containing information about the document format.
ReportPart	insertNewReportPart(int i) Internal Use Only.
boolean	isNilReportPartArray(int i) Checks if the ReportPart element is nil at the specified index position.
boolean	isNilViewSupport() Checks if the ViewSupport element is nil.
boolean	isSetChunkSize() Checks if the ChunkSize attribute is set.
boolean	isSetContentLength() Checks if the ContentLength attribute is set.
boolean	isSetLastChunk() Checks if the LastChunk attribute is set.
boolean	isSetViewSupport() Checks if the ViewSupport element is set.
void	removeReportPart(int i) Internal Use Only.
void	setChunkSize(int chunkSize) Internal Use Only.
void	setContentLength(int contentLength) Internal Use Only.
void	setLastChunk(boolean lastChunk) Internal Use Only.
void	setNilReportPartArray(int i) Internal Use Only.
void	setNilViewSupport() Internal Use Only.
void	setReportPartArray(int i, ReportPart reportPart) Internal Use Only.
void	setReportPartArray(ReportPart[] reportPartArray) Internal Use Only.
void	setViewSupport(ViewSupport viewSupport) Internal Use Only.
int	sizeOfReportPartArray() Returns the size of the ReportPart array.
void	unsetChunkSize() Internal Use Only.
void	unsetContentLength() Internal Use Only.
void	unsetLastChunk() Internal Use Only.
void	unsetViewSupport() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetChunkSize() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetContentLength() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetLastChunk() Internal Use Only.
void	xsetChunkSize(org.apache.xmlbeans.XmlInt chunkSize) Internal Use Only.
void	xsetContentLength(org.apache.xmlbeans.XmlInt contentLength) Internal Use Only.
void	xsetLastChunk(org.apache.xmlbeans.XmlBoolean lastChunk) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal use only

Method Detail

getViewSupport

ViewSupport getViewSupport()

Returns a ViewSupport containing information about the document format.

Returns:

An object containing the document format required when ReportEngine.getDocumentInformation was called.

See Also:

ViewSupport, CharacterView, XMLView, ViewModeType, RetrieveData, RetrieveView, OutputFormatType, DocumentInformation

isNilViewSupport

boolean isNilViewSupport()

Checks if the ViewSupport element is nil.

Returns:

true if the ViewSupport element is nil, otherwise false

isSetViewSupport

boolean isSetViewSupport()

Checks if the ViewSupport element is set.

Returns:

true if the ViewSupport element is set, otherwise false

setViewSupport

void setViewSupport(ViewSupport viewSupport)

Internal Use Only.

addNewViewSupport

ViewSupport addNewViewSupport()

Internal Use Only.

setNilViewSupport

void setNilViewSupport()

Internal Use Only.

unsetViewSupport

void unsetViewSupport()

Internal Use Only.

getReportPartArray

ReportPart[] getReportPartArray()

Gets a particular part of the report.

Returns:

the array of ReportPart elements

getReportPartArray

ReportPart getReportPartArray(int i)

Gets a part of the particular index within a report.

Parameters:

i - the index of the ReportPart element

Returns:

the ReportPart instance

isNilReportPartArray

boolean isNilReportPartArray(int i)

Checks if the ReportPart element is nil at the specified index position.

Parameters:

i - the index of the ReportPart element

Returns:

true if the ReportPart element is nil, otherwise false

sizeOfReportPartArray

int sizeOfReportPartArray()

Returns the size of the ReportPart array.

Returns:

the size of the ReportPart array.

setReportPartArray

void setReportPartArray(ReportPart[] reportPartArray)

Internal Use Only.

setReportPartArray

void setReportPartArray(int i,
                        ReportPart reportPart)

Internal Use Only.

setNilReportPartArray

void setNilReportPartArray(int i)

Internal Use Only.

insertNewReportPart

ReportPart insertNewReportPart(int i)

Internal Use Only.

addNewReportPart

ReportPart addNewReportPart()

Internal Use Only.

removeReportPart

void removeReportPart(int i)

Internal Use Only.

getChunkSize

int getChunkSize()

Returns the total size of the document view expressed in bytes for binary views and the total size of the document view expressed in characters for other kinds of views.

Returns:

the documents' chunk size

xgetChunkSize

org.apache.xmlbeans.XmlInt xgetChunkSize()

Internal Use Only.

isSetChunkSize

boolean isSetChunkSize()

Checks if the ChunkSize attribute is set.

Returns:

true if the ChunkSize element is set, otherwise false

setChunkSize

void setChunkSize(int chunkSize)

Internal Use Only.

xsetChunkSize

void xsetChunkSize(org.apache.xmlbeans.XmlInt chunkSize)

Internal Use Only.

unsetChunkSize

void unsetChunkSize()

Internal Use Only.

getLastChunk

boolean getLastChunk()

Returns true, if the view object is the last chunk of the document view.

Returns:

Whether the view object is the last chunk of the document view.

See Also:

RetrieveView, DocumentInformation

xgetLastChunk

org.apache.xmlbeans.XmlBoolean xgetLastChunk()

Internal Use Only.

isSetLastChunk

boolean isSetLastChunk()

Checks if the LastChunk attribute is set.

Returns:

true if the LastChunk element is set, otherwise false

setLastChunk

void setLastChunk(boolean lastChunk)

Internal Use Only.

xsetLastChunk

void xsetLastChunk(org.apache.xmlbeans.XmlBoolean lastChunk)

Internal Use Only.

unsetLastChunk

void unsetLastChunk()

Internal Use Only.

getContentLength

int getContentLength()

Returns:

• the total size of the document view expressed in bytes for binary views,
• the total size of the document view expressed in characters for other kinds of views.

Returns:

The total number of bytes or characters of the document view

See Also:

RetrieveView, DocumentInformation

xgetContentLength

org.apache.xmlbeans.XmlInt xgetContentLength()

Internal Use Only.

isSetContentLength

boolean isSetContentLength()

Checks if the ContentLength attribute is set.

Returns:

true if the ContentLength element is set, otherwise false

setContentLength

void setContentLength(int contentLength)

Internal Use Only.

xsetContentLength

void xsetContentLength(org.apache.xmlbeans.XmlInt contentLength)

Internal Use Only.

unsetContentLength

void unsetContentLength()

Internal Use Only.