TQL Model modifiers
- jrenbb
- Ashish Gupta (Unlicensed)
- Alok Batra
Need a list of possible modifiers for model attributes, their values and meaning. TQLDOC-29 - Getting issue details... STATUS
Model modifiers define the behaviors of a Model or its components.
| Construct | Modifier | Domain | Description | Default |
|---|---|---|---|---|
| Namespace | Example: <Namespace name='Cisco'> <DataModel name='User'> <Attribute name='FirstName' type='String'/> <Attribute name='LastName' type='String'/> <Attribute name='Login' type='String'/> <Attribute name='Password' type='String'/> <Identity value='Login'/> </DataModel> </Namespace> | |||
| Model | Example: <Def name="EskyCameraProviderType" inherits="CameraProviderType" combines="Login"> <String name="ProviderType" default="EskyCameraProvider" cardinality="1" modifiers="readonly"/> <CameraType name="CameraData" modifiers="virtual" combines="EskyPreset,EskyImage"/> <Unique name="Login" value="URL"/> </Def> | |||
| inherits | Will use all the attributes and actions from the parent class without duplicating them in the instance. Means if the parent class instance is modified, the child will refer to new value from the parent. | |||
| combines | Will compose it by copying the structures from the list of combines. | |||
| Attribute | ||||
| Cardinality | 0..1 | Defines the number of values, it can hold. (Nested cardinalities are not yet supported) | |
| Format | 0..1 | Attribute value format specifier | ||
| Codec | 0..1 | Attribute value coder/decoder specifier | ||
| default | Picks this as default value at the time of creating the instance | |||
| modifiers | ||||
| readonly | Will not allow queries to update the value | |||
| hidden | Will not be available for the queries | |||
| virtual | Will not be stored in the database and structure will be maintained only in memory | |||
| Data Attribute | Data Attribute is inherited from the Attribute | |||
| Thing Attribute | Thing Attribute is inherited from the Attribute | |||
| Update | "Auto" | If Action workflow need to be restarted after the workflow is completed, Update need to be set to "auto". Currently only 'auto' value is supported | ||
| KnownBy | 0..1 | Defines which actions need to be called on update of the current attributes. Associated action[s] name[s], comma-separated list | ||
| Reference | Reference is inherited from Attribute | |||
| Condition | ||||
| Type | 0..1 | Constraint's' type (e.g. eq, ne, ge, gt, le, lt etc.) only needed with generic 'Constraint' tag | ||
Constraint | ||||
| Type | 0..1 | Constraint's' type (e.g. eq, ne, ge, gt, le, lt etc.) only needed with generic 'Constraint' tag | ||
| Action |