com.businessobjects.dsws.reportengine
Interface RetrieveBinaryView

All Superinterfaces:

RetrieveView

public interface RetrieveBinaryView
extends RetrieveView

RetrieveBinaryView is used to retrieve document data in binary format inside a DocumentInformation object.

Example: Retrieve a document's contents in binary PDF format

 ViewSupport pdfViewSupport = ViewSupport.Factory.newInstance();
 pdfViewSupport.setOutputFormat(OutputFormatType.PDF);
 pdfViewSupport.setViewType(ViewType.BINARY);
 pdfViewSupport.setViewMode(ViewModeType.DOCUMENT);
 RetrieveBinaryView retBinView = RetrieveBinaryView.Factory.newInstance();
 retBinView.setViewSupport(pdfViewSupport);
 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 retBOData.setRetrieveView(retBinView);
 DocumentInformation docInfo = boRepEng.getDocumentInformation(strDocid,null,null,null,retBOData);
 BinaryView myBinView = (BinaryView) docInfo.getView();
 OutputStream outputStream = response.getOutputStream();
 response.setContentType("application/pdf");
 response.setHeader("Content-Type","application/pdf");
 response.setDateHeader("expires", 0);
 byte[] abyBinaryContent = myBinView.getContent();
 //output the binary stream via the response object
 outputStream.write(abyBinaryContent);
 

See Also:

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

Nested Class Summary

static class

RetrieveBinaryView.Factory A class with methods for creating instances of the RetrieveBinaryView 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.