com.businessobjects.datasourceparameter
Interface DataSourceParameter

public interface DataSourceParameter

The DataSourceParameter interface defines a parameter of a data source.

Example:Getting the DataSourceParameter information from the data source

 DataSource[] boUniverses = boQuerySrv.getDataSourceList();
 String boUniverseUID = boUniverses[3].getUID();
 DataSourceSpecification boUniverseSpecification = boQuerySrv.getDataSource(boUniverseUID);
 DataSourceParameter[] DSPs = boUniverseSpecification.getDataSourceParametersArray();
 for (int i = 0; i < DSPs.length; i++)
 {
        DataSourceParameter DSP = DSPs[i];
        String DSPName = DSP.getName();
        out.print(DSPName);
 }
 

Since:

12.0

See Also:

DataSourceParameterType, DataSourceParameterValue, DocumentInformation

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

org.apache.xmlbeans.XmlObject	addNewDefaultValue() Internal Use Only.
java.lang.String	getClassName() Retrieves the parameter class name.
org.apache.xmlbeans.XmlObject[]	getDefaultValueArray() Returns the default value for this parameter.
org.apache.xmlbeans.XmlObject	getDefaultValueArray(int i) Returns the default value for this parameter at the specified index position
java.lang.String	getName() Gets the name of the DataSourceParameter.
boolean	getRequired() Returns true, if a input value is required or false if it could be skipped while processing data source parameter value's setting.
DataSourceParameterType.Enum	getType() Returns the type into which the value can be converted.
org.apache.xmlbeans.XmlObject	insertNewDefaultValue(int i) Internal Use Only.
boolean	isSetClassName() Checks if the ClassName attribute is set.
boolean	isSetName() Checks if the Name attribute is set.
boolean	isSetRequired() Checks if the Required attribute is set.
boolean	isSetType() Checks if the Type attribute is set.
void	removeDefaultValue(int i) Internal Use Only.
void	setClassName(java.lang.String className) Internal Use Only.
void	setDefaultValueArray(int i, org.apache.xmlbeans.XmlObject defaultValue) Internal Use Only.
void	setDefaultValueArray(org.apache.xmlbeans.XmlObject[] defaultValueArray) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
void	setRequired(boolean required) Internal Use Only.
void	setType(DataSourceParameterType.Enum type) Internal Use Only.
int	sizeOfDefaultValueArray() Returns the number of DefaultValue element.
void	unsetClassName() Internal Use Only.
void	unsetName() Internal Use Only.
void	unsetRequired() Internal Use Only.
void	unsetType() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetClassName() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetRequired() Internal Use Only.
DataSourceParameterType	xgetType() Internal Use Only.
void	xsetClassName(org.apache.xmlbeans.XmlString className) Internal Use Only.
void	xsetName(org.apache.xmlbeans.XmlString name) Internal Use Only.
void	xsetRequired(org.apache.xmlbeans.XmlBoolean required) Internal Use Only.
void	xsetType(DataSourceParameterType type) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getDefaultValueArray

org.apache.xmlbeans.XmlObject[] getDefaultValueArray()

Returns the default value for this parameter.

Returns:

the default value, or null if there isn't one. The value should be cast in DataSourceParameterType#getType().

getDefaultValueArray

org.apache.xmlbeans.XmlObject getDefaultValueArray(int i)

Returns the default value for this parameter at the specified index position

Parameters:

i - the ith value.

Returns:

the default value.

sizeOfDefaultValueArray

int sizeOfDefaultValueArray()

Returns the number of DefaultValue element.

Returns:

the size of DefaultValue array.

setDefaultValueArray

void setDefaultValueArray(org.apache.xmlbeans.XmlObject[] defaultValueArray)

Internal Use Only.

setDefaultValueArray

void setDefaultValueArray(int i,
                          org.apache.xmlbeans.XmlObject defaultValue)

Internal Use Only.

insertNewDefaultValue

org.apache.xmlbeans.XmlObject insertNewDefaultValue(int i)

Internal Use Only.

addNewDefaultValue

org.apache.xmlbeans.XmlObject addNewDefaultValue()

Internal Use Only.

removeDefaultValue

void removeDefaultValue(int i)

Internal Use Only.

getName

java.lang.String getName()

Gets the name of the DataSourceParameter.

Returns:

this parameter's display name.

xgetName

org.apache.xmlbeans.XmlString xgetName()

Internal Use Only.

isSetName

boolean isSetName()

Checks if the Name attribute is set.

Returns:

true if the name attribute is set for DataSourceParameter.

setName

void setName(java.lang.String name)

Internal Use Only.

xsetName

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

Internal Use Only.

unsetName

void unsetName()

Internal Use Only.

getClassName

java.lang.String getClassName()

Retrieves the parameter class name. A data source parameter class allows to distinguish specific parameters.

Returns:

the parameter class name.

xgetClassName

org.apache.xmlbeans.XmlString xgetClassName()

Internal Use Only.

isSetClassName

boolean isSetClassName()

Checks if the ClassName attribute is set.

setClassName

void setClassName(java.lang.String className)

Internal Use Only.

xsetClassName

void xsetClassName(org.apache.xmlbeans.XmlString className)

Internal Use Only.

unsetClassName

void unsetClassName()

Internal Use Only.

getRequired

boolean getRequired()

Returns true, if a input value is required or false if it could be skipped while processing data source parameter value's setting.

Returns:

true if a value is required for this parameter, false otherwise.

xgetRequired

org.apache.xmlbeans.XmlBoolean xgetRequired()

Internal Use Only.

isSetRequired

boolean isSetRequired()

Checks if the Required attribute is set.

Returns:

true, if the Required attribute is set, otherwise false.

setRequired

void setRequired(boolean required)

Internal Use Only.

xsetRequired

void xsetRequired(org.apache.xmlbeans.XmlBoolean required)

Internal Use Only.

unsetRequired

void unsetRequired()

Internal Use Only.

getType

DataSourceParameterType.Enum getType()

Returns the type into which the value can be converted.

Returns:

parameter value's type.

xgetType

DataSourceParameterType xgetType()

Internal Use Only.

isSetType

boolean isSetType()

Checks if the Type attribute is set.

Returns:

true if the Type attribute is set for DataSourceParameter, otherwise false

setType

void setType(DataSourceParameterType.Enum type)

Internal Use Only.

xsetType

void xsetType(DataSourceParameterType type)

Internal Use Only.

unsetType

void unsetType()

Internal Use Only.