| 
 | ||||||||||
| PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES | |||||||||
See:
          Description
| Interface Summary | |
|---|---|
| AndExpression | A representation of the model object 'And Expression'. | 
| AtomicExpressionContext | A representation of the model object 'Atomic Expression Context'. | 
| AxisAttributes | Multi-dimensional attributes of a data element, such as a result set column. | 
| ColumnDefinition | Definition of a result set column. | 
| CompositeFilterExpression | A representation of the model object 'Composite Filter Expression'. | 
| CustomData | A representation of the model object 'Custom Data'. | 
| CustomFilterExpression | A representation of the model object 'Custom Filter Expression'. | 
| DataAccessDesign | The design of how to access a data set. | 
| DataElementAttributes | Common attributes for a data element. | 
| DataElementIdentifier | A representation of the model object 'Data Element Identifier'. | 
| DataElementIdentifiers | A representation of the model object 'Data Element Identifiers'. | 
| DataElementUIHints | UI hints for a data element. | 
| DataSetDesign | A design-time data set definition. | 
| DataSetParameters | A collection of top-level parameters defined for a data set. | 
| DataSetQuery | Defines the query of a data set. | 
| DataSourceDesign | A design-time data source definition. | 
| DesignerState | Private state of an ODA designer upon exit of a design session. | 
| DesignerStateContent | An ODA Designer's private state information; its content is a blackbox to an ODA host. | 
| DesignFactory | The Factory for the model. | 
| DesignPackage | The Package for the model. | 
| DesignPackage.Literals | Defines literals for the meta objects that represent each class, each feature of each class, each enum, and each data type | 
| DesignSessionRequest | Defines a design session requested by an ODA host designer. | 
| DesignSessionResponse | Defines a design session response to an ODA host designer upon exit of the session. | 
| DocumentRoot | |
| DynamicFilterExpression | A representation of the model object 'Dynamic Filter Expression'. | 
| DynamicValuesQuery | A dynamic set of selectable input values to be retrieved at runtime using the query defined in a data set design. | 
| ExpressionArguments | A representation of the model object 'Expression Arguments'. | 
| ExpressionParameterDefinition | A representation of the model object 'Expression Parameter Definition'. | 
| ExpressionParameters | A representation of the model object 'Expression Parameters'. | 
| ExpressionVariable | A representation of the model object 'Expression Variable'. | 
| FilterExpression | A representation of the model object 'Filter Expression'. | 
| FilterExpressionType | A representation of the model object 'Filter Expression Type'. | 
| InputElementAttributes | Common attributes for a data element defined with the input mode. | 
| InputElementUIHints | UI hints for a data element defined with the input mode. | 
| InputParameterAttributes | The attributes of a top-level input parameter, which can be either scalar or complex type. | 
| InputParameterUIHints | UI hints for a top-level parameter. | 
| Locale | Represents a specific geographical, political, or cultural region. | 
| NameValuePair | A pair of name and corresponding value. | 
| NotExpression | A representation of the model object 'Not Expression'. | 
| OdaDesignSession | Definition of an ODA design session on a Data Access Design. | 
| OrExpression | A representation of the model object 'Or Expression'. | 
| OutputElementAttributes | Common attributes for a data element defined with the output mode. | 
| ParameterDefinition | Top-level parameter definition; may be input and/or output mode. | 
| ParameterFieldDefinition | The definition of each field in a complex parameter. | 
| ParameterFields | Defines all the fields of a complex parameter. | 
| Properties | A collection of properties. | 
| Property | The property of a data design component. | 
| PropertyAttributes | The attributes of a property. | 
| ResourceIdentifiers | A representation of the model object 'Resource Identifiers'. | 
| ResultSetColumns | A collection of result set columns' definitions. | 
| ResultSetCriteria | A representation of the model object 'Result Set Criteria'. | 
| ResultSetDefinition | Definition of a single homogeneous result set returned by a data set query. | 
| ResultSets | A collection of result sets' definition and metadata. | 
| ResultSubset | A representation of the model object 'Result Subset'. | 
| ScalarValueChoices | A collection of scalar values defined for user selection. | 
| ScalarValueDefinition | Defines a scalar value with a brief description. | 
| SortKey | A representation of the model object 'Sort Key'. | 
| SortSpecification | A representation of the model object 'Sort Specification'. | 
| StaticValues | A representation of the model object 'Static Values'. | 
| ValueFormatHints | Hints on how to format a value. | 
| Enum Summary | |
|---|---|
| AxisType | A representation of the literals of the enumeration 'Axis Type', and utility methods for working with them. | 
| ElementNullability | A representation of the literals of the enumeration 'Element Nullability', and utility methods for working with them. | 
| ExpressionVariableType | A representation of the literals of the enumeration 'Expression Variable Type', and utility methods for working with them. | 
| HorizontalAlignment | A representation of the literals of the enumeration 'Horizontal Alignment', and utility methods for working with them. | 
| InputPromptControlStyle | A representation of the literals of the enumeration 'Input Prompt Control Style', and utility methods for working with them. | 
| NullOrderingType | A representation of the literals of the enumeration 'Null Ordering Type', and utility methods for working with them. | 
| OdaComplexDataType | A representation of the literals of the enumeration 'Oda Complex Data Type', and utility methods for working with them. | 
| OdaScalarDataType | A representation of the literals of the enumeration 'Oda Scalar Data Type', and utility methods for working with them. | 
| ParameterMode | A representation of the literals of the enumeration 'Parameter Mode', and utility methods for working with them. | 
| SessionStatus | A representation of the literals of the enumeration 'Session Status', and utility methods for working with them. | 
| SortDirectionType | A representation of the literals of the enumeration 'Sort Direction Type', and utility methods for working with them. | 
| TextFormatType | A representation of the literals of the enumeration 'Text Format Type', and utility methods for working with them. | 
| TextWrapType | A representation of the literals of the enumeration 'Text Wrap Type', and utility methods for working with them. | 
[Platform API] Defines an Open Data Access (ODA) design session that allows a custom ODA designer tool to specify the slice of data to access at run-time.
The ODA design-time framework provides the capability for a
third-party data source provider to optionally provide its own
custom designer.  An ODA custom designer is a data-source-specific 
query builder that provides own custom UI for an user to explore its 
meta-data and build a data set query.  
Most of the metadata are specific to individual data sources.
A custom designer is expected to encapsulate the specific knowledge and 
context of its underlying data source.  
An ODA host uses a generic set of design 
information for its data access.  The data access design 
is modeled and defined in this ODA Design Session API.
When a new data source is designed, an ODA design-time host application would initiate and request a new ODA design session with the data source's custom ODA designer. An user would step through the data-source-specific design task in a custom ODA designer. When finished, a data access design is created and passed to the ODA host in a response to the design session it has initiated.
The ODA host would in turn adapt the data access design to its
host-specific design components and persistent format.
The data access design may be edited in a later design session.
An ODA host would request another design session, and pass the
last session's pertinent information to the custom ODA designer.
After a user completes editing of the data access design, a revised
design is again passed to the ODA host for updates.
The OdaDesignSession interface is the starting point of 
the API in the ODA design-time framework.  It contains a
DesignSessionRequest and DesignSessionResponse,
each of which contains pertinent design session information and 
a DataAccessDesign.
| 
 | ||||||||||
| PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES | |||||||||