TQL Model modifiers

Owned by jrenbb
Last updated: Nov 16, 2019 by Ashish Gupta (Unlicensed)Version comment
1 min read

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.

ConstructModifierDomainDescriptionDefault
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    

 

Cardinality0..1Defines the number of values, it can hold. (Nested cardinalities are not yet supported) 
 Format0..1Attribute value format specifier 
 Codec0..1Attribute value coder/decoder specifier 
 default Picks this as default value at the time of creating the instance 
 modifiers   
  readonlyWill not allow queries to update the value 
  hiddenWill not be available for the queries 
  virtualWill 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 
 KnownBy0..1Defines 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    
 Type0..1Constraint's' type (e.g. eq, ne, ge, gt, le, lt etc.) only needed with generic 'Constraint' tag 

Constraint

    
 Type0..1Constraint's' type (e.g. eq, ne, ge, gt, le, lt etc.) only needed with generic 'Constraint' tag 
Action