Eclipse BIRT Report Object Model (ROM)
OdaDataSetParam Structure
| Display Name: | OdaDataSetParam |
| Since: | 2.1.1 |
The data set parameter definition element describes the parameters of the data set query. A parameter can be input only, output only, or both.
The Parameter Definitions section above for the rules to identify a parameter by name vs. position
Whether a null value is allowed for this parameter.
| Type: | boolean |
| Since: | 2.1.1 |
| Required: | No |
| Display Name: | Allow Null |
| JavaScript Type: | |
| Default Value: | false |
| Runtime Settable: | No |
If true, the parameter value can be null. If false, the value cannot be null.
The optional data type of the parameter.
| Type: | choice (paramType) |
| Since: | 2.1.1 |
| Required: | No |
| Display Name: | Data Type |
| JavaScript Type: | |
| Default Value: | string |
| Runtime Settable: | No |
| Name | Display Name | Value | Description |
| string | String | string | Arbitrary Unicode text. |
| float | Float | float | A scientific amount using the usual floating point notation. |
| decimal | Decimal | decimal | Any type of number including currency. Fixed decimal, arbitrary precision. |
| dateTime | Date Time | dateTime | A date, time or combination of date and time. |
| boolean | Boolean | boolean | |
| integer | Integer | integer | A whole number. |
| date | Date | date | |
| time | Time | time | |
| javaObject | Java Object | javaObject |
The optional data type of the parameter. Required only for data sets that require this information. Complex data set parameter data types, such as structure or table parameters of a query, are reserved for future releases, and are not listed in the Choices specification.
The BIRT expression that defines the default value of the input parameter.
| Type: | expression |
| Context: | factory |
| Expression Type: | any |
| Since: | reserved |
| Required: | No |
| Display Name: | Default Value |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | No |
The expression that gets evaluated and its resulting value assigned as default value of the input parameter. The default value expression, if defined, is automatically bound to the parameter only if no explicit parameter binding is defined in the data set and its corresponding report parameter.
Data Set ParamBinding structureReport Item paramBindings property
Whether the parameter is of input mode.
| Type: | boolean |
| Since: | 2.1.1 |
| Required: | No |
| Display Name: | Is Input |
| JavaScript Type: | |
| Default Value: | false |
| Runtime Settable: | No |
Indicates whether the parameter is of input mode. If true, this is an input parameter; if false, this is not an input parameter.
Whether the report must provide a value for the input parameter.
| Type: | boolean |
| Since: | 2.1.1 |
| Required: | No |
| Display Name: | Is Optional |
| JavaScript Type: | |
| Default Value: | false |
| Runtime Settable: | No |
If false, the report must provide a value for the input parameter. If true, the value is optional. This property value is not relevant if the defaultValue property is defined with a value.
Whether the parameter is of output mode.
| Type: | boolean |
| Since: | 2.1.1 |
| Required: | No |
| Display Name: | Is Output |
| JavaScript Type: | |
| Default Value: | false |
| Runtime Settable: | No |
Indicates whether the parameter is of output mode. If true, this is an output parameter; if false, this is not an output parameter.
The name of the parameter.
| Type: | string |
| Since: | 2.1.1 |
| Required: | Yes |
| Display Name: | Name |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | No |
The name of the parameter. Required. Must be unique within a data set definition.
The Parameter Definitions section above for the naming rules
The data type know to an ODA user.
| Type: | integer |
| Since: | 2.1.1 |
| Required: | No |
| Display Name: | Native Data Type Code |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | No |
This is the data type known to an ODA custom designer and runtime driver, and is provided by a custom ODA designer in an oda.design.ParameterDefinition.
The name known to an ODA user.
| Type: | literalString |
| Since: | 2.1.1 |
| Required: | No |
| Display Name: | Native Name |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | Yes |
This is the name known to an ODA custom designer and runtime driver, and is provided by a custom ODA designer in an oda.design.ParameterDefinition.
The name of the report parameter that the parameter refers to.
| Type: | string |
| Since: | 2.1.1 |
| Required: | No |
| Display Name: | Parameter Name |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | Yes |
The parameter can explicitly link to a report parameter. Once this explicit link is applied, the defaultValue is then ignored and overriden by the defaultValue in the linked report parameter.
The 1-based position of the parameter, as defined by the underlying driver.
| Type: | integer |
| Since: | 2.1.1 |
| Required: | No |
| Display Name: | Position |
| JavaScript Type: | |
| Default Value: | None |
| Runtime Settable: | No |
The 1-based position of the parameter, as defined by the underlying driver. Required for data sets that identify input parameters by position instead of name. Ignored otherwise.