com.businessobjects.dsws.reportengine
Interface RetrieveCharacterView

All Superinterfaces:

RetrieveView

public interface RetrieveCharacterView
extends RetrieveView

RetrieveCharacterView is used to retrieve document data in text format inside a DocumentInformation object.
Note: The default format to retrieve document data is HTML CharacterView.
Note: When a document is returned in HTML format, a callback script has to be used to display images embedded in the document. See Image and ImageManagement for an example of an image callback script and how to set the image callback script.

Example: Retrieve a page's contents of a document report in HTML format in chunks of 10 kilocharacters

 ViewSupport htmlViewSupport = ViewSupport.Factory.newInstance();
 htmlViewSupport.setOutputFormat(OutputFormatType.HTML);
 htmlViewSupport.setViewType(ViewType.CHARACTER);
 htmlViewSupport.setViewMode(ViewModeType.REPORT_PAGE);
 RetrieveCharacterView retCharView = RetrieveCharacterView.Factory.newInstance();
 retCharView.setViewSupport(htmlViewSupport);
 retCharView.setChunkSize(10);
 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 retBOData.setRetrieveView(retCharView);
 DocumentInformation docInfo = boRepEng.getDocumentInformation(strDocid,null,null,null,retBOData);
 CharacterView myBOView = (CharacterView)docInfo.getView();
 String docContents = myBOView.getContent();
 out.print(docContents);
 

See Also:

TransportType, BinaryView, RetrieveView, RetrieveData, DataProviderInfo, RetrieveBinaryView, RetrieveCharacterView, RetrieveCurrentReportState, RetrieveData, RetrieveDataProvidersInfo, RetrieveDrillInfo, RetrieveMustFillInfo, RetrieveNavigationMap, RetrievePromptsInfo, RetrieveQueryContext, RetrieveReportList, RetrieveView, RetrieveViewSupport, RetrieveXMLView, ReportEngine

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

TransportType.Enum	getTransport() Internal Use Only.
void	setTransport(TransportType.Enum transport) Sets the way the View will be retrieved in the returned SOAP message.
TransportType	xgetTransport() Internal Use Only.
void	xsetTransport(TransportType transport) Internal Use Only.

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

addNewCallbackOption, addNewMedia, addNewReportPartReference, addNewViewSupport, addReportPartReference, getCallbackOptionArray, getCallbackOptionArray, getChunkSize, getMediaArray, getMediaArray, getReportPartReferenceArray, getReportPartReferenceArray, getUserAgent, getViewSupport, insertNewCallbackOption, insertNewMedia, insertNewReportPartReference, insertReportPartReference, isNilCallbackOptionArray, isNilMediaArray, isNilReportPartReferenceArray, isNilViewSupport, isSetChunkSize, isSetViewSupport, removeCallbackOption, removeMedia, removeReportPartReference, setCallbackOptionArray, setCallbackOptionArray, setChunkSize, setMediaArray, setMediaArray, setNilCallbackOptionArray, setNilMediaArray, setNilReportPartReferenceArray, setNilViewSupport, setReportPartReferenceArray, setReportPartReferenceArray, setUserAgent, setViewSupport, sizeOfCallbackOptionArray, sizeOfMediaArray, sizeOfReportPartReferenceArray, unsetChunkSize, unsetViewSupport, xgetChunkSize, xgetReportPartReferenceArray, xgetReportPartReferenceArray, xgetUserAgent, xsetChunkSize, xsetReportPartReferenceArray, xsetReportPartReferenceArray, xsetUserAgent

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getTransport

TransportType.Enum getTransport()

Internal Use Only.

xgetTransport

TransportType xgetTransport()

Internal Use Only.

setTransport

void setTransport(TransportType.Enum transport)

Sets the way the View will be retrieved in the returned SOAP message.

Parameters:

transport - the type used to transport data.

See Also:

TransportType

xsetTransport

void xsetTransport(TransportType transport)

Internal Use Only.