Axis type of a result set column.
Indicates whether a data element's value can be null.
Horizontal display alignment of the data value.
The style of UI control for prompting user to input a value.
ODA complex data types.
ODA scalar data types.
Indicates whether a parameter is of input and/or output mode.
Indicates to ODA host designer on how to proceed after an ODA design session exits.
The type of text content of the data column values, i.e. plain text, HTML or RTF. It provides a hint on the type of text control to use for displaying the data value, e.g. a Text Control vs. Dynamic Text Control.
A hint on the type of text wrapping on the data column values. It could be in a single line (None), or word-wrapped (Word).
Multi-dimensional attributes of a data element, such as a result set column.
The axis type of the data element. This provides hints to a consumer application on how the column should be used.
A hint on how the dimension data element should be layout on column or row. It is normally used by presentation element such as a crosstab to design a default layout.
Multi-dimensional attributes of a data element, such as a result set column.
Definition of a result set column.
The attributes of a multi-dimensional data element.
Definition of a result set column.
The design of how to access a data set. Its model is a design tree that starts with a top-level dataSetDesign, which contains its corresponding dataSourceDesign. The top-level data set may contain nested data set designs.
The design of how to access a data set. Its model is a design tree that starts with a top-level dataSetDesign, which contains its corresponding dataSourceDesign. The top-level data set may contain nested data set designs.
Common attributes for a data element.
A name that uniquely identifies this data element. If a data element can only be identified by position, this name may be empty.
The 1-based index position (left-to-right order) within a collection of data elements. The position is defined per the underlying data source, and is not necessarily sequential. For example, a query may access 3 columns in a result set, but the data access design may choose to expose only column 2. In this case, only one column element with postion 2 is defined in the result set definition.
Native data type code of the data element. If none or unknown value (0) is specified, the data element is mapped to an ODA String data type by default. The native type code value is implementation-specific to individual ODA driver, which must support its mapping to one or more ODA data types. The supported native-ODA data type mapping must be defined in the ODA extension's plugin.xml .
Maximum number of decimal digits in a numeric value, or the length of a non-numeric value. A value of -1 indicates this attribute is not applicable.
Maximum number of digits to the right of the decimal point. A value of -1 indicates this attribute is not applicable.
Common attributes for a data element.
UI hints for a data element.
Business name of the data element. Could be localized.
More extensive description of the data element.
UI hints for a data element.
A design-time data set definition.
The instance of dataSourceDesign that supports this type of data set. Could be null, if nested within another dataSetDesign, to share the container's dataSourceDesign.
Properties specific to the underlying data set query. Public property values can be visible and editable in the host designer.
Private properties specific to the underlying data set query. Their definitions are private to the ODA designer, i.e. must not be visible nor editable by the host designer. The "private" nature only applies to the design-time behavior of an ODA host designer. At run-time, both public and private properties are combined and passed to the ODA runtime driver as a single set of runtime properties.
The unique name that identifies an instance of dataSetDesign.
The dataSet element ID defined in an ODA extension plugin manifest. It identifies the type of data set design supported by the ODA extension. Optional if only one dataSet element is defined in the manifest.
Identifies the primary result set if more than one result sets are available, and can be identified by name. If results sets are identified by sequence, the first result set is the primary one.
A design-time data set definition.
A collection of top-level parameters defined for a data set. If the metadata can be derived, i.e. can be obtained by an ODA driver in each design session, an ODA host designer is not required to include the derived metadata in the next design session request. An ODA designer may ignore such metadata in a Request.
If the metadata can be derived, i.e. can be obtained by an ODA driver in each design session, an ODA host designer is not required to include the derived metadata in the next design session request. An ODA designer may ignore such metadata in a Request.
A collection of top-level parameters defined for a data set. If the metadata can be derived, i.e. can be obtained by an ODA driver in each design session, an ODA host designer is not required to include the derived metadata in the next design session request. An ODA designer may ignore such metadata in a Request.
Defines the query of a data set. Includes the query text, and any additional query spec. Future: may include a filterSpec for dynamicFiltering.
The query command text to execute at runtime to retrieve data for this data set. Retrieved data could be for one or more result sets and/or output parameters, as defined in this data set design. The query syntax is specific to a data source; could be an empty string.
Defines the query of a data set. Includes the query text, and any additional query spec. Future: may include a filterSpec for dynamicFiltering.
A design-time data source definition.
Properties specific to the underlying data source connection. Public property values can be visible and editable in the host designer.
Private properties specific to the underlying data source connection. Their definitions are private to the ODA designer, i.e. must not be visible nor editable by the host designer.
The unique name that identifies an instance of dataSourceDesign.
The extension ID defined in an ODA extension plugin manifest. It identifies the supporting ODA driver's extension plug-in that implements the ODA run-time extension point.
The data source element ID defined in an ODA extension plugin manifest. Optional, defaults to be same as the ODA extension id if only one dataSource element is defined in the manifest.
The name of a linked connection profile.
The full path name of a linked connection profiles storage file where the linked profile is to be located at run-time. A null value indicates to use the default DTP profiles storage file.
A design-time data source definition.
Private state of an ODA designer upon exit of a design session.
Designer's private state information; its content is a blackbox to an ODA host.
Version of the designer state's data format.
Private state of an ODA designer upon exit of a design session.
An ODA Designer's private state information; its content is a blackbox to an ODA host.
State content in string format.
State content in binary format.
An ODA Designer's private state information; its content is a blackbox to an ODA host.
Defines a design session requested by an ODA host designer.
The suggested locale of the requested design session; normally the client locale of a locale-sensitive host designer. It is up to an ODA designer whether it can support and honor the suggested locale.
The private state of the ODA designer at the last design session. It can be used by an ODA designer to resume the state of its last session.
Specifies whether the design session is requested to be in an "editable" or "read-only" mode. For a read-only design session, the ODA host designer would ignore any changes found in the session response. It is up to individual ODA designer to honor the requested mode and adjusts its UI behavior.
Defines a design session requested by an ODA host designer.
Defines a design session response to an ODA host designer upon exit of the session.
The latest data access design as updated during the design session. Any updates should be made in own instance, separate from the instance provided in the design session request.
The private state of the ODA designer upon exit of a design session. An ODA host designer must handle it as a black-box; it should simply provide persistence services and pass it back in the next session request.
ODA design session exit status. This tells the ODA host designer whether the design session was successful, and how it may consume and save the session response information.
Defines a design session response to an ODA host designer upon exit of the session.
A dynamic set of selectable input values to be retrieved at runtime using the query defined in a data set design.
A nested instance of dataSetDesign to use for retrieving the set of selectable user values.
If not enabled, use staticValueChoices if defined.
The result set column name whose values are retrieved as the value choices. This attribute must be one of the column names defined in the data set design's primary result set.
The result set column name whose values are the localized name that describes the corresponding value in the valueColumn on each data row.
A dynamic set of selectable input values to be retrieved at runtime using the query defined in a data set design.
Common attributes for a data element defined with the input mode.
The literal string value to be used as the data element's default input value. Only applies to a scalar input data element.
Indicates whether this element value is editable or read-only in the host designer. A host designer can further design whether to hide this attribute. Applicable only if its container is visible, e.g. for public properties and input parameters.
Indicates whether the element requires an input value.
Indicates whether input value should be masked or encrypted in persistent store and any UI display. Applies to default value as well.
Common attributes for a data element defined with the input mode.
UI hints for a data element defined with the input mode.
Defaults to TextField if no static and dynamic value choices are defined; otherwise, defaults to SelectableList.
UI hints for a data element defined with the input mode.
The attributes of a top-level input parameter, which can be either scalar or complex type.
The attributes of a top-level input parameter, which can be either scalar or complex type.
UI hints for a top-level parameter.
For grouping multiple top-level input parameters under the same UI group prompt.
UI hints for a top-level parameter.
Represents a specific geographical, political, or cultural region.
An ISO Language Code; lower-case, two-letter codes as defined by ISO-639.
An ISO Country Code; upper-case, two-letter codes as defined by ISO-3166.
A vendor or browser-specific code.
Represents a specific geographical, political, or cultural region.
A pair of name and corresponding value.
A pair of name and corresponding value.
Definition of an ODA design session on a Data Access Design.
Definition of an ODA design session on a Data Access Design.
Common attributes for a data element defined with the output mode.
A free-format string used to identify the data element in a heading, such as a column header.
Provides additional information to the user about this data element, such as in a balloon help.
Common attributes for a data element defined with the output mode.
Top-level parameter definition. Parameter could be scalar or complex type.
Attributes applicable to both input and output parameter mode.
Required for input parameter.
Optional for an output parameter.
Applicable to complex parameter only.
Top-level parameter definition. Parameter could be scalar or complex type.
The definition of each field in a complex parameter. A parameter field is of scalar type.
Attributes applicable to both input and output parameter mode.
Required for the field of an input parameter.
Optional for the field of an output parameter.
The definition of each field in a complex parameter. A parameter field is of scalar type.
Defines all the fields of a complex parameter.
Defines all the fields of a complex parameter.
A collection of properties.
A collection of properties.
The property of a data design component.
Property name and corresponding value if available. The property value must be a string. The value may be selected from one of the value choices defined for a property.
Property attributes defined for this *instance* of DataAccessDesign. This set of attributes overrides all those pre-defined by an ODA extension in its plugin.xml. An ODA host designer should apply those pre-defined attributes by default to this instance, only if none is specified here.
The property of a data design component.
The attributes of a property.
If the property metadata can be derived, i.e. can be obtained by an ODA driver in each design session, an ODA host designer is not required to include the derived metadata in the next design session request. An ODA designer may ignore such metadata in a Request.
The attributes of a property.
A collection of result set columns' definitions.
A collection of result set columns' definitions.
Definition of a single homogeneous result set returned by a data set query.
Collection of data columns for this result set.
A name that uniquely identifies a result set at runtime. If not specified, a result set is identified by its sequence in the resultSetDefinitions.
Definition of a single homogeneous result set returned by a data set query.
A collection of result sets' definition and metadata. If the metadata can be derived, i.e. can be obtained by an ODA driver in each design session, an ODA host designer is not required to include the derived metadata in the next design session request. An ODA designer may ignore such metadata in a Request.
If the metadata can be derived, i.e. can be obtained by an ODA driver in each design session, an ODA host designer is not required to include the derived metadata in the next design session request. An ODA designer may ignore such metadata in a Request.
A collection of result sets' definition and metadata. If the metadata can be derived, i.e. can be obtained by an ODA driver in each design session, an ODA host designer is not required to include the derived metadata in the next design session request. An ODA designer may ignore such metadata in a Request.
A collection of scalar values defined for user selection.
A collection of scalar values defined for user selection.
Defines a scalar value with a brief description.
A localized name that describes the value.
Defines a scalar value with a brief description.
Hints on how to format a value.
Default display length of the data value. A value of -1 means unknown length. The default value, if not specified, is -1.
The preferred display format of the data value. It contains a data format mask, e.g. #,###.00, ShortDate, etc.
The type of text content of the data value, i.e. plain text, HTML or RTF. It provides a hint on the type of text control to use for displaying the data value, e.g. a Dynamic Text Control.
Horizontal display alignment of the data value. See valid enum values. "Automatic" means that it is up to an ODA host designer to determine the alignment based on its default rules.
A hint on the type of text wrapping on the data value. It could be in a single line (None), or word-wrapped (Word).
Hints on how to format a value.