com.businessobjects.dsws.queryservice
Interface DataProviderInformation

public interface DataProviderInformation

Provides information about the data provider associated with a query or document. A DataProviderInformation instance can be retrieved from the QueryService in two ways:

If you have constructed a new query and created the query using the QueryService.createDataProvider method, a DataProviderInformation instance for the query (or document) is returned by the method.

You can also retrieve the DataProviderInformation instances for an existing document. To do this, you pass the document reference to the QueryService.getDataProviderList method. You can also specify if you want the QuerySpecification returned.

If you have constructed a new query and created the query using the QueryService.createDataProvider method, your next step may be to use the ReportEngine service to display the resulting document. To do this, you first obtain the document reference from the DataProviderInformation instance by calling the getDocumentReference method. You can then use the document reference with the ReportEngine service. (See ReportEngine for further information about the ReportEngine service.)

Example: Get the data source name of the DataProviderInformation.

 ReturnProperties boRetProp = ReturnProperties.Factory.newInstance();
 boRetProp.setIncludeQuerySpecification(false);
 DataProviderInformation boDataProviderInfo = boQuerySrv.createDataProvider(boUniverseUID, boQuerySpec, boRetProp);
 String boQueryDocRef = boDataProviderInfo.getDocumentReference();
 DataProviderInformation[] dataproviders = boQuerySrv.getDataProviderList(boQueryDocRef, false);
 for(int i=0;i< dataproviders.length;i++)
 {
    DataProviderInformation dataprovider = dataproviders[i];
    String DPname = dataprovider.getName();
    int DProwcount = dataprovider.getRowCount();
    String source = dataprovider.getDataSourceUID();
 }
 

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

DataSourceParameterValue	addNewDataSourceParameterValues() Internal Use Only.
QuerySpecification	addNewQuerySpecification() Internal Use Only.
DataSourceParameterValue[]	getDataSourceParameterValuesArray() Gets the array of all DataSourceParameterValues elements.
DataSourceParameterValue	getDataSourceParameterValuesArray(int i) Gets the DataSourceParameterValues element at the specified index position.
java.lang.String	getDataSourceUID() Gets the name of the data source this data provider is built upon.
java.lang.String	getDocumentReference() Gets the document reference for the document (or query) associated with this DataProviderInformation instance.
int	getDuration() Gets the estimated time required to retrieve the data for this data provider.
int	getFlowCount() Gets the number of flux (record sets) contained in the query.
java.lang.String	getName() Gets the name for this DataProviderInformation instance.
boolean	getPartial() Returns true if the DataProviderInformation instance only contains partial data, otherwise false.
QuerySpecification	getQuerySpecification() Gets the QuerySpecification associated with this DataProviderInformation instance.
boolean	getRefreshable() Returns true if this DataProviderInformation can be Refreshable.
java.util.Calendar	getRefreshDate() Gets the date of the last refresh of this DataProviderInformation instance.
int	getRowCount() Gets the number of rows of data contained in the DataProviderInformation instance.
boolean	getSampledData() Returns true if this DataProviderInformation has Sampled Data.
java.lang.String	getUID() Gets the unique identifier (UID) for this DataProviderInformation instance.
DataSourceParameterValue	insertNewDataSourceParameterValues(int i) Internal Use Only.
boolean	isNilDataSourceParameterValuesArray(int i) Tests for nil ith DataSourceParameterValues element.
boolean	isSetQuerySpecification() Checks if the QuerySpecification element is set.
void	removeDataSourceParameterValues(int i) Internal Use Only.
void	setDataSourceParameterValuesArray(DataSourceParameterValue[] dataSourceParameterValuesArray) Internal Use Only.
void	setDataSourceParameterValuesArray(int i, DataSourceParameterValue dataSourceParameterValues) Internal Use Only.
void	setDataSourceUID(java.lang.String dataSourceUID) Internal Use Only.
void	setDocumentReference(java.lang.String documentReference) Internal Use Only.
void	setDuration(int duration) Internal Use Only.
void	setFlowCount(int flowCount) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
void	setNilDataSourceParameterValuesArray(int i) Internal Use Only.
void	setPartial(boolean partial) Internal Use Only.
void	setQuerySpecification(QuerySpecification querySpecification) Internal Use Only.
void	setRefreshable(boolean refreshable) Internal Use Only.
void	setRefreshDate(java.util.Calendar refreshDate) Internal Use Only.
void	setRowCount(int rowCount) Internal Use Only.
void	setSampledData(boolean sampledData) Internal Use Only.
void	setUID(java.lang.String uid) Internal Use Only.
int	sizeOfDataSourceParameterValuesArray() Returns number of DataSourceParameterValues element.
void	unsetQuerySpecification() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDataSourceUID() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDocumentReference() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetDuration() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetFlowCount() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetPartial() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetRefreshable() Internal Use Only.
org.apache.xmlbeans.XmlDateTime	xgetRefreshDate() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetRowCount() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetSampledData() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetUID() Internal Use Only.
void	xsetDataSourceUID(org.apache.xmlbeans.XmlString dataSourceUID) Internal Use Only.
void	xsetDocumentReference(org.apache.xmlbeans.XmlString documentReference) Internal Use Only.
void	xsetDuration(org.apache.xmlbeans.XmlInt duration) Internal Use Only.
void	xsetFlowCount(org.apache.xmlbeans.XmlInt flowCount) Internal Use Only.
void	xsetName(org.apache.xmlbeans.XmlString name) Internal Use Only.
void	xsetPartial(org.apache.xmlbeans.XmlBoolean partial) Internal Use Only.
void	xsetRefreshable(org.apache.xmlbeans.XmlBoolean refreshable) Internal Use Only.
void	xsetRefreshDate(org.apache.xmlbeans.XmlDateTime refreshDate) Internal Use Only.
void	xsetRowCount(org.apache.xmlbeans.XmlInt rowCount) Internal Use Only.
void	xsetSampledData(org.apache.xmlbeans.XmlBoolean sampledData) Internal Use Only.
void	xsetUID(org.apache.xmlbeans.XmlString uid) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getUID

java.lang.String getUID()

Gets the unique identifier (UID) for this DataProviderInformation instance.

Returns:

the unique identifier (UID) for this DataProviderInformation instance.

xgetUID

org.apache.xmlbeans.XmlString xgetUID()

Internal Use Only.

setUID

void setUID(java.lang.String uid)

Internal Use Only.

xsetUID

void xsetUID(org.apache.xmlbeans.XmlString uid)

Internal Use Only.

getName

java.lang.String getName()

Gets the name for this DataProviderInformation instance.

Returns:

the name for this DataProviderInformation instance.

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.

getQuerySpecification

QuerySpecification getQuerySpecification()

Gets the QuerySpecification associated with this DataProviderInformation instance.

Returns:

the QuerySpecification associated with this DataProviderInformation instance.

isSetQuerySpecification

boolean isSetQuerySpecification()

Checks if the QuerySpecification element is set.

Returns:

true if the QuerySpecification element is set, otherwise false.

setQuerySpecification

void setQuerySpecification(QuerySpecification querySpecification)

Internal Use Only.

addNewQuerySpecification

QuerySpecification addNewQuerySpecification()

Internal Use Only.

unsetQuerySpecification

void unsetQuerySpecification()

Internal Use Only.

getDataSourceParameterValuesArray

DataSourceParameterValue[] getDataSourceParameterValuesArray()

Gets the array of all DataSourceParameterValues elements.

Returns:

the array of DataSourceParameterValue elements.

getDataSourceParameterValuesArray

DataSourceParameterValue getDataSourceParameterValuesArray(int i)

Gets the DataSourceParameterValues element at the specified index position.

Parameters:

i - the index of the DataSourceParameterValues element.

Returns:

the DataSourceParameterValue instance.

isNilDataSourceParameterValuesArray

boolean isNilDataSourceParameterValuesArray(int i)

Tests for nil ith DataSourceParameterValues element.

Parameters:

i - the index of the DataSourceParameterValues element.

Returns:

true if the DataSourceParameterValues is nil, otherwise false.

sizeOfDataSourceParameterValuesArray

int sizeOfDataSourceParameterValuesArray()

Returns number of DataSourceParameterValues element.

Returns:

the size of the DataSourceParameterValues array.

setDataSourceParameterValuesArray

void setDataSourceParameterValuesArray(DataSourceParameterValue[] dataSourceParameterValuesArray)

Internal Use Only.

setDataSourceParameterValuesArray

void setDataSourceParameterValuesArray(int i,
                                       DataSourceParameterValue dataSourceParameterValues)

Internal Use Only.

setNilDataSourceParameterValuesArray

void setNilDataSourceParameterValuesArray(int i)

Internal Use Only.

insertNewDataSourceParameterValues

DataSourceParameterValue insertNewDataSourceParameterValues(int i)

Internal Use Only.

addNewDataSourceParameterValues

DataSourceParameterValue addNewDataSourceParameterValues()

Internal Use Only.

removeDataSourceParameterValues

void removeDataSourceParameterValues(int i)

Internal Use Only.

getDuration

int getDuration()

Gets the estimated time required to retrieve the data for this data provider.

Returns:

the estimated time required to retrieve the data for this data provider.

xgetDuration

org.apache.xmlbeans.XmlInt xgetDuration()

Internal Use Only.

setDuration

void setDuration(int duration)

Internal Use Only.

xsetDuration

void xsetDuration(org.apache.xmlbeans.XmlInt duration)

Internal Use Only.

getRowCount

int getRowCount()

Gets the number of rows of data contained in the DataProviderInformation instance.

Returns:

the number of rows of data contained in the DataProviderInformation instance.

xgetRowCount

org.apache.xmlbeans.XmlInt xgetRowCount()

Internal Use Only.

setRowCount

void setRowCount(int rowCount)

Internal Use Only.

xsetRowCount

void xsetRowCount(org.apache.xmlbeans.XmlInt rowCount)

Internal Use Only.

getRefreshDate

java.util.Calendar getRefreshDate()

Gets the date of the last refresh of this DataProviderInformation instance. That is, the last time data was fetched from the database.

Returns:

the date of the last refresh of this DataProviderInformation instance.

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.

getPartial

boolean getPartial()

Returns true if the DataProviderInformation instance only contains partial data, otherwise false.

Returns:

true if the DataProviderInformation instance only contains partial data, otherwise false.

xgetPartial

org.apache.xmlbeans.XmlBoolean xgetPartial()

Internal Use Only.

setPartial

void setPartial(boolean partial)

Internal Use Only.

xsetPartial

void xsetPartial(org.apache.xmlbeans.XmlBoolean partial)

Internal Use Only.

getFlowCount

int getFlowCount()

Gets the number of flux (record sets) contained in the query.

Returns:

the number of flux (record sets) contained in the query.

xgetFlowCount

org.apache.xmlbeans.XmlInt xgetFlowCount()

Internal Use Only.

setFlowCount

void setFlowCount(int flowCount)

Internal Use Only.

xsetFlowCount

void xsetFlowCount(org.apache.xmlbeans.XmlInt flowCount)

Internal Use Only.

getDataSourceUID

java.lang.String getDataSourceUID()

Gets the name of the data source this data provider is built upon.

Returns:

the name of the data source this data provider is built upon.

xgetDataSourceUID

org.apache.xmlbeans.XmlString xgetDataSourceUID()

Internal Use Only.

setDataSourceUID

void setDataSourceUID(java.lang.String dataSourceUID)

Internal Use Only.

xsetDataSourceUID

void xsetDataSourceUID(org.apache.xmlbeans.XmlString dataSourceUID)

Internal Use Only.

getDocumentReference

java.lang.String getDocumentReference()

Gets the document reference for the document (or query) associated with this DataProviderInformation instance.

Returns:

the document reference for the document (or query) associated with this DataProviderInformation instance.

xgetDocumentReference

org.apache.xmlbeans.XmlString xgetDocumentReference()

Internal Use Only.

setDocumentReference

void setDocumentReference(java.lang.String documentReference)

Internal Use Only.

xsetDocumentReference

void xsetDocumentReference(org.apache.xmlbeans.XmlString documentReference)

Internal Use Only.

getSampledData

boolean getSampledData()

Returns true if this DataProviderInformation has Sampled Data.

Returns:

"true", if this DataProviderInformation has Sampled Data, otherwise false.

xgetSampledData

org.apache.xmlbeans.XmlBoolean xgetSampledData()

Internal Use Only.

setSampledData

void setSampledData(boolean sampledData)

Internal Use Only.

xsetSampledData

void xsetSampledData(org.apache.xmlbeans.XmlBoolean sampledData)

Internal Use Only.

getRefreshable

boolean getRefreshable()

Returns true if this DataProviderInformation can be Refreshable.

Returns:

"true", if this DataProviderInformation can be Refreshable, otherwise false.

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.