com.businessobjects.datasource
Interface DataSourceClass


public interface DataSourceClass

Provides a grouping of DataSourceObject instances in the universe. DataSourceObject instances are grouped in a universe by being associated with a DataSourceClass instance. A given universe DataSourceSpecification instance may contain a number of DataSourceClass instances, each of which may contain a number of DataSourceObject instances. See DataSourceObject for an example of how to find DataSourceObject instances within a DataSourceClass instance.

See Also:
DataSourceObject, DataSourceSpecification

Nested Class Summary
static class DataSourceClass.Factory
          A class with methods for creating instances of the DataSourceClass type.
 
Field Summary
static org.apache.xmlbeans.SchemaType type
          Internal Use Only.
 
Method Summary
 DataSourceClass addNewDataSourceClasses()
          Internal Use Only.
 DataSourceObject addNewDataSourceObject()
          Internal Use Only.
 DataSourceClass[] getDataSourceClassesArray()
           Gets an array of DataSourceClass instances contained in this DataSourceClass.
 DataSourceClass getDataSourceClassesArray(int i)
           Gets the DataSourceClass instance contained at index i in the array of DataSourceClass instances in this DataSourceClass.
 DataSourceObject[] getDataSourceObjectArray()
          Gets an array of all DataSourceObject elements.
 DataSourceObject getDataSourceObjectArray(int i)
           Gets the DataSourceObject instance stored in index location i of the DataSourceObject array contained in this DataSourceClass.
 java.lang.String getDescription()
          Gets the description of this DataSourceClass.
 java.lang.String getKey()
          Gets the key of this DataSourceClass.
 java.lang.String getName()
          Gets the name of this DataSourceClass.
 DataSourceClass insertNewDataSourceClasses(int i)
          Internal Use Only.
 DataSourceObject insertNewDataSourceObject(int i)
          Internal Use Only.
 void removeDataSourceClasses(int i)
          Internal Use Only.
 void removeDataSourceObject(int i)
          Internal Use Only.
 void setDataSourceClassesArray(DataSourceClass[] dataSourceClassesArray)
          Internal Use Only.
 void setDataSourceClassesArray(int i, DataSourceClass dataSourceClasses)
          Internal Use Only.
 void setDataSourceObjectArray(DataSourceObject[] dataSourceObjectArray)
          Internal Use Only.
 void setDataSourceObjectArray(int i, DataSourceObject dataSourceObject)
          Internal Use Only.
 void setDescription(java.lang.String description)
          Internal Use Only.
 void setKey(java.lang.String key)
          Internal Use Only.
 void setName(java.lang.String name)
          Internal Use Only.
 int sizeOfDataSourceClassesArray()
          Returns the number of DataSourceClasses element.
 int sizeOfDataSourceObjectArray()
          Returns the number of DataSourceObject element.
 org.apache.xmlbeans.XmlString xgetDescription()
          Internal Use Only.
 org.apache.xmlbeans.XmlString xgetKey()
          Internal Use Only.
 org.apache.xmlbeans.XmlString xgetName()
          Internal Use Only.
 void xsetDescription(org.apache.xmlbeans.XmlString description)
          Internal Use Only.
 void xsetKey(org.apache.xmlbeans.XmlString key)
          Internal Use Only.
 void xsetName(org.apache.xmlbeans.XmlString name)
          Internal Use Only.
 

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getDataSourceClassesArray

DataSourceClass[] getDataSourceClassesArray()

Gets an array of DataSourceClass instances contained in this DataSourceClass. A given DataSourceClass instance may contain zero or more additional DataSourceClass instances.

Returns:
the array of DataSourceObject instances contained in this DataSourceClass

getDataSourceClassesArray

DataSourceClass getDataSourceClassesArray(int i)

Gets the DataSourceClass instance contained at index i in the array of DataSourceClass instances in this DataSourceClass. A given DataSourceClass instance may contain zero or more additional DataSourceClass instances.

Parameters:
i - the index of the DataSourceClass in the array
Returns:
the DataSourceClass instance contained at index i in the array of DataSourceClass instances in this DataSourceClass.

sizeOfDataSourceClassesArray

int sizeOfDataSourceClassesArray()
Returns the number of DataSourceClasses element.

Returns:
The size of DataSourceClass array.

setDataSourceClassesArray

void setDataSourceClassesArray(DataSourceClass[] dataSourceClassesArray)

Internal Use Only.


setDataSourceClassesArray

void setDataSourceClassesArray(int i,
                               DataSourceClass dataSourceClasses)

Internal Use Only.


insertNewDataSourceClasses

DataSourceClass insertNewDataSourceClasses(int i)

Internal Use Only.


addNewDataSourceClasses

DataSourceClass addNewDataSourceClasses()

Internal Use Only.


removeDataSourceClasses

void removeDataSourceClasses(int i)

Internal Use Only.


getDataSourceObjectArray

DataSourceObject[] getDataSourceObjectArray()
Gets an array of all DataSourceObject elements.

Returns:
the array of DataSourceObject instances contained in this DataSourceClass.

getDataSourceObjectArray

DataSourceObject getDataSourceObjectArray(int i)

Gets the DataSourceObject instance stored in index location i of the DataSourceObject array contained in this DataSourceClass

.

Parameters:
i - the index of the DataSourceObject in the array.
Returns:
the DataSourceObject instance stored in index location i of the DataSourceObject array contained in this DataSourceClass.

sizeOfDataSourceObjectArray

int sizeOfDataSourceObjectArray()
Returns the number of DataSourceObject element.

Returns:
the size of DataSourceObject array

setDataSourceObjectArray

void setDataSourceObjectArray(DataSourceObject[] dataSourceObjectArray)

Internal Use Only.


setDataSourceObjectArray

void setDataSourceObjectArray(int i,
                              DataSourceObject dataSourceObject)

Internal Use Only.


insertNewDataSourceObject

DataSourceObject insertNewDataSourceObject(int i)

Internal Use Only.


addNewDataSourceObject

DataSourceObject addNewDataSourceObject()

Internal Use Only.


removeDataSourceObject

void removeDataSourceObject(int i)

Internal Use Only.


getKey

java.lang.String getKey()
Gets the key of this DataSourceClass.

Returns:
the key of this DataSourceClass.

xgetKey

org.apache.xmlbeans.XmlString xgetKey()

Internal Use Only.


setKey

void setKey(java.lang.String key)

Internal Use Only.


xsetKey

void xsetKey(org.apache.xmlbeans.XmlString key)

Internal Use Only.


getName

java.lang.String getName()
Gets the name of this DataSourceClass.

Returns:
the name of this DataSourceClass.

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 of this DataSourceClass.

Returns:
the description of this DataSourceClass.

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.