com.businessobjects.dsws.reportengine
Interface CharacterView

All Superinterfaces:

View

public interface CharacterView
extends View

The CharacterView is a interface for the character document output.

Example: Retrieve the document's contents in character HTML format

 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 retBOData.setRetrieveView(RetrieveView.Factory.newInstance());
 DocumentInformation docInfo = boRepEng.getDocumentInformation(strDocid,null,null,null,retBOData);

 CharacterView myBOView = (CharacterView)docInfo.getView();
 String docContents = myBOView.getContent();
 out.print(docContents);
 

See Also:

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

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

java.lang.String	getContent() Returns the document contents.
java.lang.String	getMimeType() Returns the mime type of the document.
boolean	isSetContent() Checks if the Content element is set.
boolean	isSetMimeType() Checks if the MimeType attribute is set.
void	setContent(java.lang.String 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	xgetContent() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetMimeType() Internal Use Only.
void	xsetContent(org.apache.xmlbeans.XmlString content) 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

java.lang.String getContent()

Returns the document contents.

Returns:

a string containing the document contents.

xgetContent

org.apache.xmlbeans.XmlString xgetContent()

Internal Use Only.

isSetContent

boolean isSetContent()

Checks if the Content element is set.

Returns:

true if the Content element is set, otherwise false.

setContent

void setContent(java.lang.String content)

Internal Use Only.

xsetContent

void xsetContent(org.apache.xmlbeans.XmlString content)

Internal Use Only.

unsetContent

void unsetContent()

Internal Use Only.

getMimeType

java.lang.String getMimeType()

Returns the mime type of the document.

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 attribute 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.