com.businessobjects.dsws.reportengine
Interface XMLView

All Superinterfaces:

View

public interface XMLView
extends View

XMLView interface is used to output the report's view in XML format.

Example: Retrieve a document report in XML format

 ViewSupport xmlViewSupport = ViewSupport.Factory.newInstance();
 xmlViewSupport.setOutputFormat(OutputFormatType.XML);
 xmlViewSupport.setViewType(ViewType.XML);
 xmlViewSupport.setViewMode(ViewModeType.REPORT);
 RetrieveXMLView retXMLView = RetrieveXMLView.Factory.newInstance();
 retXMLView.setViewSupport(xmlViewSupport);
 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 retBOData.setRetrieveView(retXMLView);
 DocumentInformation docInfo = boRepEng.getDocumentInformation(strDocid, null, null, null, retBOData);
 XMLView myBOView = (XMLView) docInfo.getView();
 org.apache.xmlbeans.XmlString docContents = (org.apache.xmlbeans.XmlString)myBOView.getContent();
 String xmlString = docContents.getStringValue();
 

See Also:

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

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

org.apache.xmlbeans.XmlObject	addNewContent() Appends and returns a new empty Content element.
org.apache.xmlbeans.XmlObject	getContent() Returns the document's content in XML format.
java.lang.String	getMimeType() Returns the document mime type.
boolean	isSetContent() Checks if the Content element is set.
boolean	isSetMimeType() Checks if the MimeType attribute is set.
void	setContent(org.apache.xmlbeans.XmlObject content) Internal Use Only.
void	setMimeType(java.lang.String mimeType) Internal Use Only.
void	unsetContent() Internal Use Only.
void	unsetMimeType() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetMimeType() Internal Use Only.
void	xsetMimeType(org.apache.xmlbeans.XmlString mimeType) Internal Use Only.

Methods inherited from interface com.businessobjects.dsws.reportengine.View

addNewReportPart, addNewViewSupport, getChunkSize, getContentLength, getLastChunk, getReportPartArray, getReportPartArray, getViewSupport, insertNewReportPart, isNilReportPartArray, isNilViewSupport, isSetChunkSize, isSetContentLength, isSetLastChunk, isSetViewSupport, removeReportPart, setChunkSize, setContentLength, setLastChunk, setNilReportPartArray, setNilViewSupport, setReportPartArray, setReportPartArray, setViewSupport, sizeOfReportPartArray, unsetChunkSize, unsetContentLength, unsetLastChunk, unsetViewSupport, xgetChunkSize, xgetContentLength, xgetLastChunk, xsetChunkSize, xsetContentLength, xsetLastChunk

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getContent

org.apache.xmlbeans.XmlObject getContent()

Returns the document's content in XML format.

Returns:

return the document's content in XML format.

isSetContent

boolean isSetContent()

Checks if the Content element is set.

Returns:

true if the Content element is set, otherwise false

setContent

void setContent(org.apache.xmlbeans.XmlObject content)

Internal Use Only.

addNewContent

org.apache.xmlbeans.XmlObject addNewContent()

Appends and returns a new empty Content element.

Returns:

A new empty Content element.

unsetContent

void unsetContent()

Internal Use Only.

getMimeType

java.lang.String getMimeType()

Returns the document mime type.

For a list of possible mime types, see getMimeType.

Returns:

a string containing the document mime type.

xgetMimeType

org.apache.xmlbeans.XmlString xgetMimeType()

Internal Use Only.

isSetMimeType

boolean isSetMimeType()

Checks if the MimeType attribute is set.

Returns:

true if the MimeType element is set, otherwise false

setMimeType

void setMimeType(java.lang.String mimeType)

Internal Use Only.

xsetMimeType

void xsetMimeType(org.apache.xmlbeans.XmlString mimeType)

Internal Use Only.

unsetMimeType

void unsetMimeType()

Internal Use Only.