Class DataProvider

This is the basic class that represents a data provider. This class exposes main functions used to initialize and retrieve information from a DataProvider.
Defined in: dfDataWidget.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	DataProvider(screen, dataWidget) Construct a new DataProvider object.

Method Summary
Method Attributes	Method Name and Description
	clearParameters() Clear all parameters associated with the provider
	construct(dataProviderName, screen, dataWidget)
	execute() Execute the DataProvider.
	getDataAsText() Return the data resulting from the DataProvider execution as Text.
	getDataAsXML() Return the data resulting from the DataProvider execution as XML.
	setParameter() Add a parameter to the DataProvider request

Class Detail

DataProvider(screen, dataWidget)

Construct a new DataProvider object.

Parameters:
{String} dataProviderName.: The DataProvider name.
screen
dataWidget

Returns:: A new DataProvider instance

Method Detail

clearParameters()

Clear all parameters associated with the provider

construct(dataProviderName, screen, dataWidget)

Parameters:
dataProviderName
screen
dataWidget

execute()

Execute the DataProvider.

{String} getDataAsText()

Return the data resulting from the DataProvider execution as Text.

{Document} getDataAsXML()

Return the data resulting from the DataProvider execution as XML.

setParameter()

Add a parameter to the DataProvider request

Parameters:
{String} name.: The parameter name.
{String} value.: The parameter value.

Classes

Class DataProvider