com.businessobjects.dsws.reportengine
Interface RetrieveData

public interface RetrieveData

The RetrieveData interface is used to select the information stored in the DocumentInformation object returned by the ReportEngine.getDocumentInformation Web Service call.

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, RetrieveView, RetrieveData, DataProviderInfo, RetrieveBinaryView, RetrieveCharacterView, RetrieveCurrentReportState, RetrieveData, RetrieveDataProvidersInfo, RetrieveDrillInfo, RetrieveMustFillInfo, RetrieveNavigationMap, RetrievePromptsInfo, RetrieveQueryContext, RetrieveReportList, RetrieveView, RetrieveViewSupport, RetrieveXMLView, ReportEngine

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

RetrieveCurrentReportState	addNewRetrieveCurrentReportState() Appends and returns a new empty RetrieveCurrentReportState element
RetrieveDataProvidersInfo	addNewRetrieveDataProvidersInfo() Appends and returns a new empty RetrieveDataProvidersInfo element
RetrieveDrillInfo	addNewRetrieveDrillInfo() Appends and returns a new empty RetrieveDrillInfo element
RetrieveNavigationMap	addNewRetrieveNavigationMap() Appends and returns a new empty RetrieveNavigationMap element.
RetrieveReportList	addNewRetrieveReportList() Appends and returns a new empty RetrieveReportList element.
RetrieveView	addNewRetrieveView() Appends and returns a new empty RetrieveView element.
RetrieveViewSupport	addNewRetrieveViewSupport() Appends and returns a new empty RetrieveViewSupport element
RetrieveCurrentReportState	getRetrieveCurrentReportState() Internal Use Only.
RetrieveDataProvidersInfo	getRetrieveDataProvidersInfo() Internal Use Only.
RetrieveDrillInfo	getRetrieveDrillInfo() Internal Use Only.
RetrieveNavigationMap	getRetrieveNavigationMap() Internal Use Only.
RetrieveReportList	getRetrieveReportList() Internal Use Only.
RetrieveView	getRetrieveView() Internal Use Only.
RetrieveViewSupport	getRetrieveViewSupport() Internal Use Only.
boolean	isNilRetrieveCurrentReportState() Checks if the RetrieveCurrentReportState element is nil.
boolean	isNilRetrieveDataProvidersInfo() Checks if the RetrieveDataProvidersInfo element is nil.
boolean	isNilRetrieveDrillInfo() Checks if the RetrieveDrillInfo element is nil.
boolean	isNilRetrieveNavigationMap() Checks if the RetrieveNavigationMap element is nil.
boolean	isNilRetrieveReportList() Checks if the RetrieveReportList element is nil.
boolean	isNilRetrieveView() Checks if the RetrieveView element is nil.
boolean	isNilRetrieveViewSupport() Checks if the RetrieveViewSupport element is nil.
boolean	isSetRetrieveCurrentReportState() Checks if the RetrieveCurrentReportState element is set.
boolean	isSetRetrieveDataProvidersInfo() Checks if the RetrieveDataProvidersInfo element is set.
boolean	isSetRetrieveDrillInfo() Checks if the RetrieveDrillInfo element is set.
boolean	isSetRetrieveNavigationMap() Checks if the RetrieveNavigationMap element is set.
boolean	isSetRetrieveReportList() Checks if the RetrieveReportList element is set.
boolean	isSetRetrieveView() Checks if the RetrieveView element is set.
boolean	isSetRetrieveViewSupport() Checks if the RetrieveViewSupport element is set.
void	setNilRetrieveCurrentReportState() Sets the RetrieveCurrentReportState element to nil.
void	setNilRetrieveDataProvidersInfo() Sets if the RetrieveDataProvidersInfo element is nil.
void	setNilRetrieveDrillInfo() Sets the RetrieveDrillInfo element to nil.
void	setNilRetrieveNavigationMap() Sets the RetrieveNavigationMap element to nil.
void	setNilRetrieveReportList() Sets the RetrieveReportList element to nil.
void	setNilRetrieveView() Sets the RetrieveView element to nil.
void	setNilRetrieveViewSupport() Sets the RetrieveViewSupport element to nil.
void	setRetrieveCurrentReportState(RetrieveCurrentReportState retrieveCurrentReportState) Retrieves information about a state of the selected report inside a DocumentInformation object.
void	setRetrieveDataProvidersInfo(RetrieveDataProvidersInfo retrieveDataProvidersInfo) Retrieves information about a document's DataProviders inside a DocumentInformation object.
void	setRetrieveDrillInfo(RetrieveDrillInfo retrieveDrillInfo) Retrieves information about the possible Drill Actions that can be performed on this document.
void	setRetrieveNavigationMap(RetrieveNavigationMap retrieveNavigationMap) Retrieves the NavigationNode tree inside a DocumentInformation object retrieved by the ReportEngine.getDocumentInformation Web Service call.
void	setRetrieveReportList(RetrieveReportList retrieveReportList) Retrieves a list of reports contained inside this document.
void	setRetrieveView(RetrieveView retrieveView) Sets the format in which the document view will be retrieved by the ReportEngine.getDocumentInformation Web Service call.
void	setRetrieveViewSupport(RetrieveViewSupport retrieveViewSupport) Retrieves the list of ViewSupport in which it is possible to display the document.
void	unsetRetrieveCurrentReportState() Unsets the RetrieveCurrentReportState element.
void	unsetRetrieveDataProvidersInfo() Unsets the RetrieveDataProvidersInfo element.
void	unsetRetrieveDrillInfo() Unsets the RetrieveDrillInfo element.
void	unsetRetrieveNavigationMap() Unsets the RetrieveNavigationMap element.
void	unsetRetrieveReportList() Unsets the RetrieveReportList element.
void	unsetRetrieveView() Unsets the RetrieveView element.
void	unsetRetrieveViewSupport() Unsets the RetrieveViewSupport element.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getRetrieveNavigationMap

RetrieveNavigationMap getRetrieveNavigationMap()

Internal Use Only.

isNilRetrieveNavigationMap

boolean isNilRetrieveNavigationMap()

Checks if the RetrieveNavigationMap element is nil.

Returns:

true if the RetrieveNavigationMap element is nil, otherwise false

isSetRetrieveNavigationMap

boolean isSetRetrieveNavigationMap()

Checks if the RetrieveNavigationMap element is set.

Returns:

true if the RetrieveNavigationMap element is set, otherwise false

setRetrieveNavigationMap

void setRetrieveNavigationMap(RetrieveNavigationMap retrieveNavigationMap)

Retrieves the NavigationNode tree inside a DocumentInformation object retrieved by the ReportEngine.getDocumentInformation Web Service call. The NavigationMap of the entire document is an array of NavigationNode. The root level contains the reports, all lower levels are associated to sections and sub sections. This model is exposed as a tree.

Parameters:

retrieveNavigationMap - a RetrieveNavigationMap object.

See Also:

RetrieveData, RetrieveNavigationMap, NavigationNode

addNewRetrieveNavigationMap

RetrieveNavigationMap addNewRetrieveNavigationMap()

Appends and returns a new empty RetrieveNavigationMap element.

Returns:

a new empty RetrieveNavigationMap element.

setNilRetrieveNavigationMap

void setNilRetrieveNavigationMap()

Sets the RetrieveNavigationMap element to nil.

unsetRetrieveNavigationMap

void unsetRetrieveNavigationMap()

Unsets the RetrieveNavigationMap element.

getRetrieveView

RetrieveView getRetrieveView()

Internal Use Only.

isNilRetrieveView

boolean isNilRetrieveView()

Checks if the RetrieveView element is nil.

Returns:

true if the RetrieveView element is nil, otherwise false

isSetRetrieveView

boolean isSetRetrieveView()

Checks if the RetrieveView element is set.

Returns:

true if the RetrieveView element is set, otherwise false

setRetrieveView

void setRetrieveView(RetrieveView retrieveView)

Sets the format in which the document view will be retrieved by the ReportEngine.getDocumentInformation Web Service call.

Parameters:

retrieveView - view format to be retrieved with the DocumentInformation object.

See Also:

BinaryView, CharacterView, XMLView, RetrieveView

addNewRetrieveView

RetrieveView addNewRetrieveView()

Appends and returns a new empty RetrieveView element.

Returns:

a new empty RetrieveView element.

setNilRetrieveView

void setNilRetrieveView()

Sets the RetrieveView element to nil.

unsetRetrieveView

void unsetRetrieveView()

Unsets the RetrieveView element.

getRetrieveDataProvidersInfo

RetrieveDataProvidersInfo getRetrieveDataProvidersInfo()

Internal Use Only.

isNilRetrieveDataProvidersInfo

boolean isNilRetrieveDataProvidersInfo()

Checks if the RetrieveDataProvidersInfo element is nil.

Returns:

true if the RetrieveDataProvidersInfo element is nil, otherwise false

isSetRetrieveDataProvidersInfo

boolean isSetRetrieveDataProvidersInfo()

Checks if the RetrieveDataProvidersInfo element is set.

Returns:

true if the RetrieveDataProvidersInfo element is set, otherwise false

setRetrieveDataProvidersInfo

void setRetrieveDataProvidersInfo(RetrieveDataProvidersInfo retrieveDataProvidersInfo)

Retrieves information about a document's DataProviders inside a DocumentInformation object.
That is to say the Universe, stored procedure or flat file used to build BusinessObjects documents.
A BusinessObjects document may have more than one DataProvider.
See RetrieveDataProvidersInfo for an example of how to use this method.

Parameters:

retrieveDataProvidersInfo - a RetrieveDataProvidersInfo object.

See Also:

RetrieveView, RetrieveData, DataProviderInfo, ReportEngine, DocumentInformation

addNewRetrieveDataProvidersInfo

RetrieveDataProvidersInfo addNewRetrieveDataProvidersInfo()

Appends and returns a new empty RetrieveDataProvidersInfo element

Returns:

a new empty RetrieveDataProvidersInfo element

setNilRetrieveDataProvidersInfo

void setNilRetrieveDataProvidersInfo()

Sets if the RetrieveDataProvidersInfo element is nil.

unsetRetrieveDataProvidersInfo

void unsetRetrieveDataProvidersInfo()

Unsets the RetrieveDataProvidersInfo element.

getRetrieveCurrentReportState

RetrieveCurrentReportState getRetrieveCurrentReportState()

Internal Use Only.

isNilRetrieveCurrentReportState

boolean isNilRetrieveCurrentReportState()

Checks if the RetrieveCurrentReportState element is nil.

Returns:

true if the RetrieveCurrentReportState element is nil, otherwise false

isSetRetrieveCurrentReportState

boolean isSetRetrieveCurrentReportState()

Checks if the RetrieveCurrentReportState element is set.

Returns:

true if the RetrieveCurrentReportState element is set, otherwise false

setRetrieveCurrentReportState

void setRetrieveCurrentReportState(RetrieveCurrentReportState retrieveCurrentReportState)

Retrieves information about a state of the selected report inside a DocumentInformation object.
The ReportState object holds information about the condition of the report currently selected by the user.
See RetrieveCharacterView for an example of how the retrieve methods are used.

Parameters:

retrieveCurrentReportState - a RetrieveCurrentReportState object

See Also:

RetrieveCurrentReportState, RetrieveView, RetrieveData, DataProviderInfo, ReportEngine, DocumentInformation

addNewRetrieveCurrentReportState

RetrieveCurrentReportState addNewRetrieveCurrentReportState()

Appends and returns a new empty RetrieveCurrentReportState element

Returns:

a new empty RetrieveCurrentReportState element

setNilRetrieveCurrentReportState

void setNilRetrieveCurrentReportState()

Sets the RetrieveCurrentReportState element to nil.

unsetRetrieveCurrentReportState

void unsetRetrieveCurrentReportState()

Unsets the RetrieveCurrentReportState element.

getRetrieveReportList

RetrieveReportList getRetrieveReportList()

Internal Use Only.

isNilRetrieveReportList

boolean isNilRetrieveReportList()

Checks if the RetrieveReportList element is nil.

Returns:

true if the RetrieveReportList element is nil, otherwise false

isSetRetrieveReportList

boolean isSetRetrieveReportList()

Checks if the RetrieveReportList element is set.

Returns:

true if the RetrieveReportList element is set, otherwise false

setRetrieveReportList

void setRetrieveReportList(RetrieveReportList retrieveReportList)

Retrieves a list of reports contained inside this document. The Report object holds information about a report contained in a document.
An array of the reports contained in a document is retrieved using DocumentInformation.getReports()

Parameters:

retrieveReportList - a RetrieveReportList object.

See Also:

RetrieveReportList, RetrieveView, RetrieveData, DataProviderInfo, ReportEngine, DocumentInformation

addNewRetrieveReportList

RetrieveReportList addNewRetrieveReportList()

Appends and returns a new empty RetrieveReportList element.

Returns:

a new empty RetrieveReportList element

setNilRetrieveReportList

void setNilRetrieveReportList()

Sets the RetrieveReportList element to nil.

unsetRetrieveReportList

void unsetRetrieveReportList()

Unsets the RetrieveReportList element.

getRetrieveViewSupport

RetrieveViewSupport getRetrieveViewSupport()

Internal Use Only.

isNilRetrieveViewSupport

boolean isNilRetrieveViewSupport()

Checks if the RetrieveViewSupport element is nil.

Returns:

true if the RetrieveViewSupport element is nil, otherwise false

isSetRetrieveViewSupport

boolean isSetRetrieveViewSupport()

Checks if the RetrieveViewSupport element is set.

Returns:

true if the RetrieveViewSupport element is set, otherwise false

setRetrieveViewSupport

void setRetrieveViewSupport(RetrieveViewSupport retrieveViewSupport)

Retrieves the list of ViewSupport in which it is possible to display the document.

Parameters:

retrieveViewSupport - a RetrieveViewSupport object.

See Also:

ViewSupport, RetrieveViewSupport, RetrieveView, RetrieveData, DataProviderInfo, ReportEngine, DocumentInformation

addNewRetrieveViewSupport

RetrieveViewSupport addNewRetrieveViewSupport()

Appends and returns a new empty RetrieveViewSupport element

Returns:

a new empty RetrieveViewSupport element

setNilRetrieveViewSupport

void setNilRetrieveViewSupport()

Sets the RetrieveViewSupport element to nil.

unsetRetrieveViewSupport

void unsetRetrieveViewSupport()

Unsets the RetrieveViewSupport element.

getRetrieveDrillInfo

RetrieveDrillInfo getRetrieveDrillInfo()

Internal Use Only.

isNilRetrieveDrillInfo

boolean isNilRetrieveDrillInfo()

Checks if the RetrieveDrillInfo element is nil.

Returns:

true if the RetrieveDrillInfo element is nil, otherwise false

isSetRetrieveDrillInfo

boolean isSetRetrieveDrillInfo()

Checks if the RetrieveDrillInfo element is set.

Returns:

true if the RetrieveDrillInfo element is set, otherwise false

setRetrieveDrillInfo

void setRetrieveDrillInfo(RetrieveDrillInfo retrieveDrillInfo)

Retrieves information about the possible Drill Actions that can be performed on this document.
DrillInfo contains the information necessary to perform a drill in a document with the drill activated.
See DrillInfo for an example of how use the DrillInfo object.
See Drill for an example of how to activate the drill in a document.

Parameters:

retrieveDrillInfo - a RetrieveDrillInfo object.

addNewRetrieveDrillInfo

RetrieveDrillInfo addNewRetrieveDrillInfo()

Appends and returns a new empty RetrieveDrillInfo element

Returns:

a new empty RetrieveDrillInfo element

setNilRetrieveDrillInfo

void setNilRetrieveDrillInfo()

Sets the RetrieveDrillInfo element to nil.

unsetRetrieveDrillInfo

void unsetRetrieveDrillInfo()

Unsets the RetrieveDrillInfo element.