FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION | DETAIL: IMPORT | CONSTANT | MEMBER | ACTION |
Constant summary | |
---|---|
string | EXTRA_PARAMS_METADATA_PREFIX := "Metadata:"
Prefix for identifying metadata entries in the extraParams dictionary. Entries with key names prefixed by the EXTRA_PARAMS_METADATA_PREFIX string are considered metadata entries. |
Member summary | |
---|---|
string | msgId
Optional application-defined message identifier used to correlate requests and responses. |
string | dvName
The name that uniquely identifies this DataView (e.g. DataView_XXX). |
string | dvDisplayName
The display name of the DataView (e.g. "XXX manager"). |
string | dvDescription
Optional field containing a description of this DataView (e.g. "This DataView exposes XXX objects"). |
sequence<string> | fieldNames
Specifies the names of each field exposed by the DataView. |
sequence<string> | fieldTypes
Specifies the types corresponding to each field in the fieldNames sequence. Supported types are: string, float, integer, boolean, decimal. |
sequence<string> | keyFields
Optional set of field names whose values in an Item are to be combined to make a unique key that can be used instead of the dvItemId field of DataViewDeleteItem, DataViewUpdateItem, and DataViewUpdateDelta events. |
dictionary<string, string> | extraParams
Optional dictionary of extra parameters. DataView implementation-specific parameters may also be stored here. |
Constant detail |
---|
string EXTRA_PARAMS_METADATA_PREFIX := "Metadata:"Prefix for identifying metadata entries in the extraParams dictionary. Entries with key names prefixed by the EXTRA_PARAMS_METADATA_PREFIX string are considered metadata entries.
Member detail |
---|
string dvDescriptionOptional field containing a description of this DataView (e.g. "This DataView exposes XXX objects").
string dvDisplayNameThe display name of the DataView (e.g. "XXX manager").
string dvNameThe name that uniquely identifies this DataView (e.g. DataView_XXX).
dictionary<string, string> extraParamsOptional dictionary of extra parameters. DataView implementation-specific parameters may also be stored here.
sequence<string> fieldNamesSpecifies the names of each field exposed by the DataView.
sequence<string> fieldTypesSpecifies the types corresponding to each field in the fieldNames sequence. Supported types are: string, float, integer, boolean, decimal.
sequence<string> keyFieldsOptional set of field names whose values in an Item are to be combined to make a unique key that can be used instead of the dvItemId field of DataViewDeleteItem, DataViewUpdateItem, and DataViewUpdateDelta events.
string msgIdOptional application-defined message identifier used to correlate requests and responses.
FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION | DETAIL: IMPORT | CONSTANT | MEMBER | ACTION |