ScriptDataSet

A data set defined in JavaScript.

Description

Represents a data set defined in JavaScript code, providing methods for opening, fetching and closing the data set. It defines the overall properties of the scripted data set including the JavaScript methods themselves and an optional result set definition.

See Also

Script Data Source element

DataSet scripting object

See Also

dataSource

The database connection that the data set is used.

Description

Name of the data source, that is the database connection this data set is using.

See Also

DataSetParam structure

ParamBinding structure

open

Opens the data set.

Description

Opens the external data set. Throws a JavaScript exception if the open fails. Often refers to report parameters or user-defined parameters for information about the data set. Optional.

See Also

beforeOpen method

afterOpen method

describe

Dynamically describes the result set definition in JavaScript.

Return

The Describe method can return null, which tells BIRT to use the static definition instead. The script can access the static description using the design object within the script.

If the method returns a column array, then the array must satisfy the following constraints:

Description

Called before BIRT calls the beforeOpen method. Creates a runt-time definition of the result set columns. Returns an array of ResultSetColumn objects. Each object describes a column in the expected result set. Optional.

See Also

ResultSetColumn structure

fetch

Fetches a row from the data set.

Return

Returns true if there is another row to fetch, false if there are no more rows. When the data set has returned the last row from the result set, subsequent calls to fetch should return false.

Description

Fetches a row from the data set on each call, and populates the current row available in the row property.

See Also

onFetch method

DataRow scripting object

close

Called by BIRT to close the data set.

Description

Closes the data set. Optional.

See Also

beforeClose method

afterClose method