com.businessobjects.dsws.reportengine
Interface DataProviderInfo

public interface DataProviderInfo

The DataProviderInfo contains information about the query(s) used to build the report.A WebIntelligence report may have more than one data provider.

Example: Retrieve a documents DataProviders.

 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 RetrieveDataProvidersInfo retBoDP = RetrieveDataProvidersInfo.Factory.newInstance();
 retBOData.setRetrieveDataProvidersInfo(retBoDP);
 DocumentInformation boDocInfo = boRepEng.getDocumentInformation(strDocid, null, null, null, retBOData);
 DataProviderInfo[] docDataProviders = boDocInfo.getDataProviderInfoArray();
 

See Also:

RetrieveView, RetrieveData, RetrieveDataProvidersInfo, ReportEngine, DocumentInformation

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

java.lang.String	getID() Returns the ID of the DataProvider.
java.lang.String	getName() Return the name of the DataProvider.
boolean	getRefreshable() Returns true, if the data provider is refreshable.
java.util.Calendar	getRefreshDate() Return the last time this DataProvider was refreshed.
int	getRefreshDuration() Return the time take for the last refresh of this DataProvider.
void	setID(java.lang.String id) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
void	setRefreshable(boolean refreshable) Internal Use Only.
void	setRefreshDate(java.util.Calendar refreshDate) Internal Use Only.
void	setRefreshDuration(int refreshDuration) Internal Use Only.
org.apache.xmlbeans.XmlString	xgetID() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetRefreshable() Internal Use Only.
org.apache.xmlbeans.XmlDateTime	xgetRefreshDate() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetRefreshDuration() Internal Use Only.
void	xsetID(org.apache.xmlbeans.XmlString id) Internal Use Only.
void	xsetName(org.apache.xmlbeans.XmlString name) Internal Use Only.
void	xsetRefreshable(org.apache.xmlbeans.XmlBoolean refreshable) Internal Use Only.
void	xsetRefreshDate(org.apache.xmlbeans.XmlDateTime refreshDate) Internal Use Only.
void	xsetRefreshDuration(org.apache.xmlbeans.XmlInt refreshDuration) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getID

java.lang.String getID()

Returns the ID of the DataProvider.

Returns:

The ID of the DataProvider.

xgetID

org.apache.xmlbeans.XmlString xgetID()

Internal Use Only.

setID

void setID(java.lang.String id)

Internal Use Only.

xsetID

void xsetID(org.apache.xmlbeans.XmlString id)

Internal Use Only.

getName

java.lang.String getName()

Return the name of the DataProvider.

Returns:

the name of the DataProvider.

xgetName

org.apache.xmlbeans.XmlString xgetName()

Internal Use Only.

setName

void setName(java.lang.String name)

Internal Use Only.

xsetName

void xsetName(org.apache.xmlbeans.XmlString name)

Internal Use Only.

getRefreshDate

java.util.Calendar getRefreshDate()

Return the last time this DataProvider was refreshed.

Returns:

the last time this DataProvider was refreshed.

xgetRefreshDate

org.apache.xmlbeans.XmlDateTime xgetRefreshDate()

Internal Use Only.

setRefreshDate

void setRefreshDate(java.util.Calendar refreshDate)

Internal Use Only.

xsetRefreshDate

void xsetRefreshDate(org.apache.xmlbeans.XmlDateTime refreshDate)

Internal Use Only.

getRefreshDuration

int getRefreshDuration()

Return the time take for the last refresh of this DataProvider.

Returns:

the time take for the last refresh of this DataProvider

xgetRefreshDuration

org.apache.xmlbeans.XmlInt xgetRefreshDuration()

Internal Use Only.

setRefreshDuration

void setRefreshDuration(int refreshDuration)

Internal Use Only.

xsetRefreshDuration

void xsetRefreshDuration(org.apache.xmlbeans.XmlInt refreshDuration)

Internal Use Only.

getRefreshable

boolean getRefreshable()

Returns true, if the data provider is refreshable.

For personal data provider, getRefreshable() method will return false.

Example: Check whether the data provider is refreshable

 RetrieveDataProvidersInfo objRetrieveDataProvidersInfo = RetrieveDataProvidersInfo.Factory.newInstance();
 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 retBOData.setRetrieveDataProvidersInfo(objRetrieveDataProvidersInfo);
 DocumentInformation boDocInfo = objReportEngine.getDocumentInformation(docid, null, null, null, retBOData);
 DataProviderInfo[] dps = boDocInfo.getDataProviderInfoArray();
 DataProviderInfo dp = dps[0];
 out.println(dp.getRefreshable());
 

xgetRefreshable

org.apache.xmlbeans.XmlBoolean xgetRefreshable()

Internal Use Only.

setRefreshable

void setRefreshable(boolean refreshable)

Internal Use Only.

xsetRefreshable

void xsetRefreshable(org.apache.xmlbeans.XmlBoolean refreshable)

Internal Use Only.