com.businessobjects.dsws.reportengine
Class RetrieveCharacterView

java.lang.Object
  com.businessobjects.dsws.reportengine.RetrieveView
      com.businessobjects.dsws.reportengine.RetrieveCharacterView

All Implemented Interfaces:

java.io.Serializable

public class RetrieveCharacterView

extends RetrieveView

implements java.io.Serializable

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 = new ViewSupport();
htmlViewSupport.setOutputFormat(OutputFormatType.HTML);
htmlViewSupport.setViewType(ViewType.CHARACTER);
htmlViewSupport.setViewMode(ViewModeType.REPORT_PAGE);

RetrieveCharacterView retCharView = new RetrieveCharacterView();
retCharView.setViewSupport(htmlViewSupport);
retCharView.setChunkSize(10);

RetrieveData retBOData = new RetrieveData();
retBOData.setRetrieveView(retCharView);

DocumentInformation docInfo = boReportEngine.getDocumentInformation(struid, null, null, null, retBOData);
CharacterView myBOView = (CharacterView) boDocInfo.getView();
String docChunk = myBOView.getContent();
struid = docInfo.getDocumentReference();

while (true)
{


if (myBOView.isLastChunk())
break;

docInfo = boReportEngine.getDocumentInformation(struid, null, null, null, retBOData);
myBOView = (CharacterView) boDocInfo.getView();
docChunk = myBOView.getContent();
}


See Also:

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

Constructor Summary

RetrieveCharacterView()
Instantiate a new blank RetrieveCharacterView object.

Method Summary

boolean	equals(java.lang.Object obj) Internal Use Only.
static org.apache.axis.encoding.Deserializer	getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Internal Use Only.
static org.apache.axis.encoding.Serializer	getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Internal Use Only.
TransportType	getTransport() Internal Use Only.
static org.apache.axis.description.TypeDesc	getTypeDesc() Internal Use Only.
int	hashCode() Internal Use Only.
void	setTransport(TransportType transport) Set the way the View will be retrieved in the returned SOAP message.

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

getCallbackOption, getCallbackOption, getChunkSize, getMedia, getMedia, getReportPartReference, getReportPartReference, getUserAgent, getViewSupport, setCallbackOption, setCallbackOption, setChunkSize, setMedia, setMedia, setReportPartReference, setReportPartReference, setUserAgent, setViewSupport

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RetrieveCharacterView

public RetrieveCharacterView()

Instantiate a new blank RetrieveCharacterView object.

Method Detail

getTransport

public TransportType getTransport()

Internal Use Only.

setTransport

public void setTransport(TransportType transport)

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

Parameters:

transport - the type used to transport data.

See Also:

TransportType

equals

public boolean equals(java.lang.Object obj)

Internal Use Only.

Overrides:

equals in class RetrieveView

hashCode

public int hashCode()

Internal Use Only.

Overrides:

hashCode in class RetrieveView

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Internal Use Only.

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)

Internal Use Only.

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)

Internal Use Only.