com.businessobjects.dsws.queryservice
Interface DataSource

public interface DataSource

Represents a universe in the Enterprise system. Once you have obtained a DataSource instance, you can use the UID stored with the DataSource instance to obtain a DataSourceSpecification instance from the QueryService service. The DataSourceSpecification interface provides access to the Detail, Dimension, MeasurePreConditionObject objects in the universe. You can use these objects in a query.
Note: You must first obtain an instance of a QueryService object to obtain a DataSource instance.

Example: Using a DataSource instance to obtain a DataSourceSpecification.

 DataSource[] boUniverseList = boQueryService.getDataSourceList();
 String boUniverseUID = boUniverseList[4].getUID();
 DataSourceSpecification boUniverseSpec = boQueryService.getDataSource(boUniverseUID);
 

See Also:

QueryService

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

java.lang.String	getDescription() Gets the description for the data source (universe).
boolean	getEditable() Checks if the DataProvider is editable.
java.lang.String	getName() Gets the name of the data source (universe).
java.lang.String	getParentFolderName() Gets the Name of the folder containing this data source (universe).
java.lang.String	getParentFolderUID() Gets the CUID of the folder containing this data source (universe).
java.lang.String	getUID() Gets the UID for the data source (universe).
boolean	isSetParentFolderName() Checks if the ParentFolderName element is set.
boolean	isSetParentFolderUID() Checks if the ParentFolderUID element is set.
void	setDescription(java.lang.String description) Internal Use Only.
void	setEditable(boolean editable) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
void	setParentFolderName(java.lang.String parentFolderName) Internal Use Only.
void	setParentFolderUID(java.lang.String parentFolderUID) Internal Use Only.
void	setUID(java.lang.String uid) Internal Use Only.
void	unsetParentFolderName() Internal Use Only.
void	unsetParentFolderUID() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDescription() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetEditable() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetParentFolderName() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetParentFolderUID() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetUID() Internal Use Only.
void	xsetDescription(org.apache.xmlbeans.XmlString description) Internal Use Only.
void	xsetEditable(org.apache.xmlbeans.XmlBoolean editable) Internal Use Only.
void	xsetName(org.apache.xmlbeans.XmlString name) Internal Use Only.
void	xsetParentFolderName(org.apache.xmlbeans.XmlString parentFolderName) Internal Use Only.
void	xsetParentFolderUID(org.apache.xmlbeans.XmlString parentFolderUID) 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

getName

java.lang.String getName()

Gets the name of the data source (universe). The universe designer specifies the name of the universe or data source. It is a human readable String.

Returns:

a String that represents the name of the universe (data source).

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.

getDescription

java.lang.String getDescription()

Gets the description for the data source (universe). The universe designer specifies the description of the universe or data source. It is a human readable String.

Returns:

a String that represents the description for the universe (data source)

xgetDescription

org.apache.xmlbeans.XmlString xgetDescription()

Internal Use Only.

setDescription

void setDescription(java.lang.String description)

Internal Use Only.

xsetDescription

void xsetDescription(org.apache.xmlbeans.XmlString description)

Internal Use Only.

getParentFolderUID

java.lang.String getParentFolderUID()

Gets the CUID of the folder containing this data source (universe).

Returns:

a String that represents the CUID of the universe (data source).

xgetParentFolderUID

org.apache.xmlbeans.XmlString xgetParentFolderUID()

Internal Use Only.

isSetParentFolderUID

boolean isSetParentFolderUID()

Checks if the ParentFolderUID element is set.

Returns:

true if the ParentFolderID element is set, otherwise false

setParentFolderUID

void setParentFolderUID(java.lang.String parentFolderUID)

Internal Use Only.

xsetParentFolderUID

void xsetParentFolderUID(org.apache.xmlbeans.XmlString parentFolderUID)

Internal Use Only.

unsetParentFolderUID

void unsetParentFolderUID()

Internal Use Only.

getParentFolderName

java.lang.String getParentFolderName()

Gets the Name of the folder containing this data source (universe).

Returns:

a String that represents the Name of the universe (data source).

xgetParentFolderName

org.apache.xmlbeans.XmlString xgetParentFolderName()

Internal Use Only.

isSetParentFolderName

boolean isSetParentFolderName()

Checks if the ParentFolderName element is set.

Returns:

true if the ParentFolderName element is set, otherwise false

setParentFolderName

void setParentFolderName(java.lang.String parentFolderName)

Internal Use Only.

xsetParentFolderName

void xsetParentFolderName(org.apache.xmlbeans.XmlString parentFolderName)

Internal Use Only.

unsetParentFolderName

void unsetParentFolderName()

Internal Use Only.

getUID

java.lang.String getUID()

Gets the UID for the data source (universe). The data source UID can be used to obtain a DataSourceSpecification instance from the QueryService service. The DataSourceSpecification class provides information about the universe, such as the Detail, Dimension, Measure, and PreConditionObject objects contained in the universe.

Example: Using a data source UID to obtain a DataSourceSpecification.

 DataSource[] boUniverseList = boQueryService.getDataSourceList();
 String boUniverseUID = boUniverseList[4].getUID();
 DataSourceSpecification boUniverseSpec = boQueryService.getDataSource(boUniverseUID);
 

Returns:

a String that represents the UID of the universe (data source).

See Also:

QueryService

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.

getEditable

boolean getEditable()

Checks if the DataProvider is editable.

Returns:

true if the DataProvider is editable, otherwise false

xgetEditable

org.apache.xmlbeans.XmlBoolean xgetEditable()

Internal Use Only.

setEditable

void setEditable(boolean editable)

Internal Use Only.

xsetEditable

void xsetEditable(org.apache.xmlbeans.XmlBoolean editable)

Internal Use Only.