com.businessobjects.datasourceparameter
Interface DataSourceParameterValue

public interface DataSourceParameterValue

The DataSourceParameterValue interface defines the value for data source parameter..

Example:Retrieving the DataSourceParameterValues information

 RetrieveDataSourceParameterValues RDSPV = RetrieveDataSourceParameterValues.Factory.newInstance();
 RetrieveMustFillInfo fillinfo = RetrieveMustFillInfo.Factory.newInstance();
 fillinfo.setRetrieveDataSourceParameterValues(RDSPV);
 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 RetrieveView retBOView = RetrieveView.Factory.newInstance();
 retBOData.setRetrieveView(retBOView);
 DocumentInformation boDocInfo = objReportEngine.getDocumentInformation(docid,fillinfo,null,null,retBOData);
 DataSourceParameterValue[] DSPVs = boDocInfo.getDataSourceParameterValuesArray();
 for(int i =0; i <DSPVs.length;i++)
 {
         DataSourceParameterValue DSPV = DSPVs[i];
         out.println("DataProvider name: " +DSPV.getDPName());
         out.println("DataProvider ID: " +DSPV.getDPId());
         out.println("DataSourceParameter: " +DSPV.getParameter().getName());
         out.println("DataSourceParameterValue: " +DSPV.getValue());
 }
 

Since:

12.0

See Also:

DataSourceParameterType, DataSourceParameterValue, DocumentInformation

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

DataSourceParameter	addNewParameter() Internal Use Only.
org.apache.xmlbeans.XmlObject	addNewValue() Appends and returns a new empty Value element.
boolean	getDefaultValue() Gets the DefaultValue attribute.
DataSourceParameter	getParameter() Returns the data source parameter.
org.apache.xmlbeans.XmlObject	getValue() Returns the current parameter value.
boolean	isNilParameter() Checks if the Parameter element is nil.
boolean	isNilValue() Checks if the Value element is nil.
boolean	isSetDefaultValue() Checks if the DefaultValue attribute is set.
boolean	isSetParameter() Checks if the Parameter element is set.
void	setDefaultValue(boolean defaultValue) Internal Use Only.
void	setNilParameter() Internal Use Only.
void	setNilValue() Sets the Value element to nil.
void	setParameter(DataSourceParameter parameter) Internal Use Only.
void	setValue(org.apache.xmlbeans.XmlObject value) Sets the value for this parameter.
void	unsetDefaultValue() Internal Use Only.
void	unsetParameter() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetDefaultValue() Internal Use Only.
void	xsetDefaultValue(org.apache.xmlbeans.XmlBoolean defaultValue) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getParameter

DataSourceParameter getParameter()

Returns the data source parameter.

Returns:

DataSourceParameter definition for this value.

isNilParameter

boolean isNilParameter()

Checks if the Parameter element is nil.

Returns:

true if the Parameter attribute is nil, otherwise false.

isSetParameter

boolean isSetParameter()

Checks if the Parameter element is set.

Returns:

true if the Parameter attribute is set, otherwise false.

setParameter

void setParameter(DataSourceParameter parameter)

Internal Use Only.

addNewParameter

DataSourceParameter addNewParameter()

Internal Use Only.

setNilParameter

void setNilParameter()

Internal Use Only.

unsetParameter

void unsetParameter()

Internal Use Only.

getValue

org.apache.xmlbeans.XmlObject getValue()

Returns the current parameter value.

Returns:

generic typed XmlObject. Object type is defined by DataSourceParameter.getType().

isNilValue

boolean isNilValue()

Checks if the Value element is nil.

Returns:

true if the value attribute is nil, otherwise false.

setValue

void setValue(org.apache.xmlbeans.XmlObject value)

Sets the value for this parameter.

Parameters:

value - any xmlbean object XmlObject instance which type is defined by DataSourceParameter.getType().

addNewValue

org.apache.xmlbeans.XmlObject addNewValue()

Appends and returns a new empty Value element.

Returns:

a new empty "Value" element.

setNilValue

void setNilValue()

Sets the Value element to nil.

getDefaultValue

boolean getDefaultValue()

Gets the DefaultValue attribute.

Returns:

the DefaultValue attribute.

xgetDefaultValue

org.apache.xmlbeans.XmlBoolean xgetDefaultValue()

Internal Use Only.

isSetDefaultValue

boolean isSetDefaultValue()

Checks if the DefaultValue attribute is set.

Returns:

true if the DefaultValue is set, otherwise false

setDefaultValue

void setDefaultValue(boolean defaultValue)

Internal Use Only.

xsetDefaultValue

void xsetDefaultValue(org.apache.xmlbeans.XmlBoolean defaultValue)

Internal Use Only.

unsetDefaultValue

void unsetDefaultValue()

Internal Use Only.