com.businessobjects.dsws.reportengine
Interface RetrieveXMLView

All Superinterfaces:

RetrieveView

public interface RetrieveXMLView
extends RetrieveView

RetrieveXMLView is used to retrieve document data in XML format inside a DocumentInformation object.

Example: Retrieve a document's contents 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:

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

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

TransportType.Enum	getTransport() Internal Use Only.
java.lang.String	getXPath() Internal Use Only.
boolean	isNilXPath() Checks if the XPath element is nil.
boolean	isSetTransport() Checks if the Transport attribute is set.
boolean	isSetXPath() Checks if the XPath element is set.
void	setNilXPath() Sets the XPath element to nil.
void	setTransport(TransportType.Enum transport) For future use.
void	setXPath(java.lang.String xPath) Sets the XPath to filter the XML generated by the Web Services provider and retrieve only the parts required by a user.
void	unsetTransport() Unsets the Transport attribute.
void	unsetXPath() Unsets the XPath element.
TransportType	xgetTransport() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetXPath() Internal Use Only.
void	xsetTransport(TransportType transport) Internal Use Only.
void	xsetXPath(org.apache.xmlbeans.XmlString xPath) 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

getXPath

java.lang.String getXPath()

Internal Use Only.

xgetXPath

org.apache.xmlbeans.XmlString xgetXPath()

Internal Use Only.

isNilXPath

boolean isNilXPath()

Checks if the XPath element is nil.

Returns:

true if the XPath element is nil, otherwise false

isSetXPath

boolean isSetXPath()

Checks if the XPath element is set.

Returns:

true if the XPath element is set, otherwise false

setXPath

void setXPath(java.lang.String xPath)

Sets the XPath to filter the XML generated by the Web Services provider and retrieve only the parts required by a user.
For more information on XPath, see here.
Note: To retrieve a full XMLView, set the XPath to null.

Parameters:

xPath - the path used to filter the XML.

xsetXPath

void xsetXPath(org.apache.xmlbeans.XmlString xPath)

Internal Use Only.

setNilXPath

void setNilXPath()

Sets the XPath element to nil.

unsetXPath

void unsetXPath()

Unsets the XPath element.

getTransport

TransportType.Enum getTransport()

Internal Use Only.

xgetTransport

TransportType xgetTransport()

Internal Use Only.

isSetTransport

boolean isSetTransport()

Checks if the Transport attribute is set.

Returns:

true if the Transport element is set, otherwise false

setTransport

void setTransport(TransportType.Enum transport)

For future use.
Set the way the View will be retrieved in the returned SOAP message.
Note: Currently, SOAPSTYLE is the only TransportType that can be used. This is also the default value.

Parameters:

transport - the type used to transport data.

See Also:

TransportType

xsetTransport

void xsetTransport(TransportType transport)

Internal Use Only.

unsetTransport

void unsetTransport()

Unsets the Transport attribute.