@harishreddym/baqend

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Baqend JavaScript SDK 2.14.1 - Class: CollectionAttribute</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link rel="shortcut icon" type="image/x-icon" href="img/favicon.ico"> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/bootstrap-baqend.min.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> <link type="text/css" rel="stylesheet" href="styles/font-awesome-4.7.0.css"> </head> <body> <nav class="navbar navbar-default navbar-fixed-top" role="navigation"> <div class="navbar-inner container">  <div class="navbar-header">  <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button>  <a class="navbar-brand" href="/"><img src="img/logo.png"></a> </div>  <div id="nav" class="navbar-collapse collapse">  <form class="navbar-right form-inline search-form"> <div class="form-group search-form-group"> <input type="search" class="form-control search-input" id="search-query" placeholder="Search Guide" name="q" autocomplete="off"> <div id="search-results" class="search-results"> <p class="search-no-results">Please enter a search query ...</p> </div> <i class="search-icon fa fa-search"></i> </div> </form>  <ul class="nav navbar-nav"> <li> <a href="https://dashboard.baqend.com/">Dashboard</a> </li>  <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Guide <b class="caret"></b></a> <ul class="dropdown-menu"> <li><a href="https://www.baqend.com/guide/">Home</a></li> <li><a href="https://www.baqend.com/guide/#speed-kit">Speed Kit</a></li> <li><a href="https://www.baqend.com/guide/#platform">Platform</a></li> <li><a href="https://www.baqend.com/guide/roadmap/">Roadmap</a></li> <li><a href="https://www.baqend.com/guide/topics/faq/">FAQ</a></li> </ul> </li>  <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Starter Kits <b class="caret"></b></a> <ul class="dropdown-menu"> <li><a href="https://www.baqend.com/guide/starter-kits/">Starter Kits Overview</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/angular2/">Angular 2 Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/react/">React and Redux Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/bootstrap/">Bootstrap Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/ionic2/">Ionic 2 Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/ionic/">Ionic Starter Kit</a></li> </ul> </li> <li class="active"> <a href="baqend.html">JS API</a> </li> <li> <a href="https://www.baqend.com/tutorial.html">Tutorial</a> </li> </ul> </div> </div> </nav> <div class="box gray pt-32 pb-32"> <div class="container"> <div class="row">  <div class="bs-sidebar hidden-print fixed affix" role="complementary"> <input class="filter form-control input-sm" type="text" placeholder="FILTER"/> <ul class="nav bs-sidenav"> <li class=""><a href="Acl.html" class="nav-name">Acl</a></li> <li class=""><a href="EntityManager.html" class="nav-name">EntityManager</a></li> <li class=""><a href="EntityManagerFactory.html" class="nav-name">EntityManagerFactory</a></li> <li class=""><a href="GeoPoint.html" class="nav-name">GeoPoint</a></li> <li class=""><a href="RealtimeEvent.html" class="nav-name">RealtimeEvent</a></li> <li class=""><a href="baqend.html" class="nav-name">baqend</a></li> <li class=""> <a href="binding.html" class="nav-name">binding</a> <ul class="nav"> <li class=""><a href="binding.Accessor.html" class="nav-name">Accessor</a></li> <li class=""><a href="binding.DeviceFactory.html" class="nav-name">DeviceFactory</a></li> <li class=""><a href="binding.Enhancer.html" class="nav-name">Enhancer</a></li> <li class=""><a href="binding.Entity.html" class="nav-name">Entity</a></li> <li class=""><a href="binding.EntityFactory.html" class="nav-name">EntityFactory</a></li> <li class=""><a href="binding.Factory.html" class="nav-name">Factory</a></li> <li class=""><a href="binding.File.html" class="nav-name">File</a></li> <li class=""><a href="binding.FileFactory.html" class="nav-name">FileFactory</a></li> <li class=""><a href="binding.Managed.html" class="nav-name">Managed</a></li> <li class=""><a href="binding.ManagedFactory.html" class="nav-name">ManagedFactory</a></li> <li class=""><a href="binding.Role.html" class="nav-name">Role</a></li> <li class=""><a href="binding.User.html" class="nav-name">User</a></li> <li class=""><a href="binding.UserFactory.html" class="nav-name">UserFactory</a></li> </ul> </li> <li class=""> <a href="caching.html" class="nav-name">caching</a> <ul class="nav"> <li class=""><a href="caching.BloomFilter.html" class="nav-name">BloomFilter</a></li> </ul> </li> <li class=""> <a href="connector.html" class="nav-name">connector</a> <ul class="nav"> <li class=""><a href="connector.Connector.html" class="nav-name">Connector</a></li> <li class=""><a href="connector.FetchConnector.html" class="nav-name">FetchConnector</a></li> <li class=""><a href="connector.IFrameConnector.html" class="nav-name">IFrameConnector</a></li> <li class=""><a href="connector.Message.html" class="nav-name">Message</a></li> <li class=""><a href="connector.NodeConnector.html" class="nav-name">NodeConnector</a></li> <li class=""><a href="connector.ObservableStream.html" class="nav-name">ObservableStream</a></li> <li class=""><a href="connector.WebSocketConnector.html" class="nav-name">WebSocketConnector</a></li> <li class=""><a href="connector.XMLHttpConnector.html" class="nav-name">XMLHttpConnector</a></li> <li class=""><a href="connector.ChannelMessage.html" class="nav-name">ChannelMessage</a></li> </ul> </li> <li class=""> <a href="error.html" class="nav-name">error</a> <ul class="nav"> <li class=""><a href="error.CommunicationError.html" class="nav-name">CommunicationError</a></li> <li class=""><a href="error.EntityExistsError.html" class="nav-name">EntityExistsError</a></li> <li class=""><a href="error.IllegalEntityError.html" class="nav-name">IllegalEntityError</a></li> <li class=""><a href="error.PersistentError.html" class="nav-name">PersistentError</a></li> <li class=""><a href="error.RollbackError.html" class="nav-name">RollbackError</a></li> </ul> </li> <li class="active"> <a href="metamodel.html" class="nav-name">metamodel</a> <ul class="nav"> <li class=""><a href="metamodel.Attribute.html" class="nav-name">Attribute</a></li> <li class=""><a href="metamodel.BasicType.html" class="nav-name">BasicType</a></li> <li class="active"><a href="metamodel.CollectionAttribute.html" class="nav-name">CollectionAttribute</a></li> <li class=""><a href="metamodel.DbIndex.html" class="nav-name">DbIndex</a></li> <li class=""><a href="metamodel.EmbeddableType.html" class="nav-name">EmbeddableType</a></li> <li class=""><a href="metamodel.EntityType.html" class="nav-name">EntityType</a></li> <li class=""><a href="metamodel.ListAttribute.html" class="nav-name">ListAttribute</a></li> <li class=""><a href="metamodel.ManagedType.html" class="nav-name">ManagedType</a></li> <li class=""><a href="metamodel.MapAttribute.html" class="nav-name">MapAttribute</a></li> <li class=""><a href="metamodel.Metamodel.html" class="nav-name">Metamodel</a></li> <li class=""><a href="metamodel.ModelBuilder.html" class="nav-name">ModelBuilder</a></li> <li class=""><a href="metamodel.PluralAttribute.html" class="nav-name">PluralAttribute</a></li> <li class=""><a href="metamodel.SetAttribute.html" class="nav-name">SetAttribute</a></li> <li class=""><a href="metamodel.SingularAttribute.html" class="nav-name">SingularAttribute</a></li> <li class=""><a href="metamodel.Type.html" class="nav-name">Type</a></li> </ul> </li> <li class=""> <a href="model.html" class="nav-name">model</a> <ul class="nav"> <li class=""><a href="model.Device.html" class="nav-name">Device</a></li> <li class=""><a href="model.Role.html" class="nav-name">Role</a></li> <li class=""><a href="model.User.html" class="nav-name">User</a></li> </ul> </li> <li class=""> <a href="partialupdate.html" class="nav-name">partialupdate</a> <ul class="nav"> <li class=""><a href="partialupdate.EntityPartialUpdateBuilder.html" class="nav-name">EntityPartialUpdateBuilder</a></li> <li class=""><a href="partialupdate.PartialUpdateBuilder.html" class="nav-name">PartialUpdateBuilder</a></li> <li class=""><a href="partialupdate.UpdateOperation.html" class="nav-name">UpdateOperation</a></li> </ul> </li> <li class=""> <a href="query.html" class="nav-name">query</a> <ul class="nav"> <li class=""><a href="query.Builder.html" class="nav-name">Builder</a></li> <li class=""><a href="query.Filter.html" class="nav-name">Filter</a></li> <li class=""><a href="query.Node.html" class="nav-name">Node</a></li> <li class=""><a href="query.Operator.html" class="nav-name">Operator</a></li> <li class=""><a href="query.Query.html" class="nav-name">Query</a></li> <li class=""><a href="query.Stream.html" class="nav-name">Stream</a></li> <li class=""><a href="query.Condition.html" class="nav-name">Condition</a></li> </ul> </li> <li class=""> <a href="util.html" class="nav-name">util</a> <ul class="nav"> <li class=""><a href="util.Code.html" class="nav-name">Code</a></li> <li class=""><a href="util.Lockable.html" class="nav-name">Lockable</a></li> <li class=""><a href="util.Logger.html" class="nav-name">Logger</a></li> <li class=""><a href="util.Metadata.html" class="nav-name">Metadata</a></li> <li class=""><a href="util.Modules.html" class="nav-name">Modules</a></li> <li class=""><a href="util.Permission.html" class="nav-name">Permission</a></li> <li class=""><a href="util.PushMessage.html" class="nav-name">PushMessage</a></li> <li class=""><a href="util.TokenStorage.html" class="nav-name">TokenStorage</a></li> <li class=""><a href="util.ValidationResult.html" class="nav-name">ValidationResult</a></li> <li class=""><a href="util.Validator.html" class="nav-name">Validator</a></li> <li class=""><a href="util.TokenStorageFactory.html" class="nav-name">TokenStorageFactory</a></li> </ul> </li> </ul> </div> <div class="col-md-12" id="main"> <div class="content"> <h1 class="page-title">Class: CollectionAttribute</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span> <span class="ancestors"><a href="metamodel.html">metamodel</a>.</span>CollectionAttribute<span class="signature">(name, elementType)</span><span class="type-signature"></span></h2> </header> <article> <div class="container-overview"> <h4 class="name" id="CollectionAttribute"><span class="type-signature"></span>new CollectionAttribute<span class="signature">(name, elementType)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>elementType</code></td> <td class="type"> <span class="param-type"><a href="metamodel.Type.html">metamodel.Type</a></span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_CollectionAttribute.js.html">lib/metamodel/CollectionAttribute.js</a>, <a href="lib_metamodel_CollectionAttribute.js.html#line9">line 9</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Extends</h3> <ul> <li><a href="metamodel.PluralAttribute.html">metamodel.PluralAttribute</a></li> </ul> <h3 class="subsection-title">Members</h3> <h4 class="name" id="accessor"><span class="type-signature"></span>accessor<span class="type-signature"> :<a href="binding.Accessor.html">binding.Accessor</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="binding.Accessor.html">binding.Accessor</a></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#accessor">metamodel.Attribute#accessor</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line53">line 53</a> </li></ul></dd> </dl> <h4 class="name" id="collectionType"><span class="type-signature">(readonly) </span>collectionType<span class="type-signature"> :PluralAttribute.CollectionType</span></h4> <div class="description"> <p>Returns the collection attribute type</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">PluralAttribute.CollectionType</span> </li> </ul> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="metamodel.PluralAttribute.html#collectionType">metamodel.PluralAttribute#collectionType</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_PluralAttribute.js.html">lib/metamodel/PluralAttribute.js</a>, <a href="lib_metamodel_PluralAttribute.js.html#line54">line 54</a> </li></ul></dd> </dl> <h4 class="name" id="declaringType"><span class="type-signature"></span>declaringType<span class="type-signature"> :<a href="metamodel.ManagedType.html">metamodel.ManagedType</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="metamodel.ManagedType.html">metamodel.ManagedType</a></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#declaringType">metamodel.Attribute#declaringType</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line55">line 55</a> </li></ul></dd> </dl> <h4 class="name" id="elementType"><span class="type-signature"></span>elementType<span class="type-signature"> :<a href="metamodel.Type.html">metamodel.Type</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="metamodel.Type.html">metamodel.Type</a></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.PluralAttribute.html#elementType">metamodel.PluralAttribute#elementType</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_PluralAttribute.js.html">lib/metamodel/PluralAttribute.js</a>, <a href="lib_metamodel_PluralAttribute.js.html#line76">line 76</a> </li></ul></dd> </dl> <h4 class="name" id="isAcl"><span class="type-signature"></span>isAcl<span class="type-signature"> :boolean</span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#isAcl">metamodel.Attribute#isAcl</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line46">line 46</a> </li></ul></dd> </dl> <h4 class="name" id="isAssociation"><span class="type-signature">(readonly) </span>isAssociation<span class="type-signature"> :boolean</span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#isAssociation">metamodel.Attribute#isAssociation</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line22">line 22</a> </li></ul></dd> </dl> <h4 class="name" id="isCollection"><span class="type-signature">(readonly) </span>isCollection<span class="type-signature"> :boolean</span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#isCollection">metamodel.Attribute#isCollection</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line30">line 30</a> </li></ul></dd> </dl> <h4 class="name" id="isId"><span class="type-signature"></span>isId<span class="type-signature"> :boolean</span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#isId">metamodel.Attribute#isId</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line42">line 42</a> </li></ul></dd> </dl> <h4 class="name" id="isMetadata"><span class="type-signature"></span>isMetadata<span class="type-signature"> :boolean</span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#isMetadata">metamodel.Attribute#isMetadata</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line40">line 40</a> </li></ul></dd> </dl> <h4 class="name" id="isVersion"><span class="type-signature"></span>isVersion<span class="type-signature"> :boolean</span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#isVersion">metamodel.Attribute#isVersion</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line44">line 44</a> </li></ul></dd> </dl> <h4 class="name" id="metadata"><span class="type-signature"></span>metadata<span class="type-signature"> :Object.<string, string>|null</span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type">Object.<string, string></span> | <span class="param-type">null</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#metadata">metamodel.Attribute#metadata</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line57">line 57</a> </li></ul></dd> </dl> <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#name">metamodel.Attribute#name</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line49">line 49</a> </li></ul></dd> </dl> <h4 class="name" id="order"><span class="type-signature"></span>order<span class="type-signature"> :number</span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#order">metamodel.Attribute#order</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line51">line 51</a> </li></ul></dd> </dl> <h4 class="name" id="persistentAttributeType"><span class="type-signature">(readonly) </span>persistentAttributeType<span class="type-signature"> :Attribute.PersistentAttributeType</span></h4> <div class="description"> <p>Returns the persistent attribute type</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Attribute.PersistentAttributeType</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#persistentAttributeType">metamodel.Attribute#persistentAttributeType</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line14">line 14</a> </li></ul></dd> </dl> <h4 class="name" id="typeConstructor"><span class="type-signature"></span>typeConstructor<span class="type-signature"> :Class.<*></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type">Class.<*></span> </li> </ul> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="metamodel.PluralAttribute.html#typeConstructor">metamodel.PluralAttribute#typeConstructor</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_PluralAttribute.js.html">lib/metamodel/PluralAttribute.js</a>, <a href="lib_metamodel_PluralAttribute.js.html#line78">line 78</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="getJsonValue"><span class="type-signature">(abstract) </span>getJsonValue<span class="signature">(state, object, options)</span><span class="type-signature"> → {*}</span></h4> <div class="description"> <p>Gets this attribute value form the object as json</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>state</code></td> <td class="type"> <span class="param-type"><a href="util.Metadata.html">util.Metadata</a></span> </td> <td class="description last"><p>The root object state</p></td> </tr> <tr> <td class="name"><code>object</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="description last"><p>The object which contains the value of this attribute</p></td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>additional options which are applied through the conversion</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#getJsonValue">metamodel.Attribute#getJsonValue</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line124">line 124</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The converted json value</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">*</span> </dd> </dl> <h4 class="name" id="getMetadata"><span class="type-signature"></span>getMetadata<span class="signature">(key)</span><span class="type-signature"> → {null|string}</span></h4> <div class="description"> <p>Gets some metadata of this type</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#getMetadata">metamodel.Attribute#getMetadata</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line108">line 108</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">null</span> | <span class="param-type">string</span> </dd> </dl> <h4 class="name" id="getValue"><span class="type-signature"></span>getValue<span class="signature">(entity)</span><span class="type-signature"> → {*}</span></h4> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>entity</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#getValue">metamodel.Attribute#getValue</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line79">line 79</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">*</span> </dd> </dl> <h4 class="name" id="hasMetadata"><span class="type-signature"></span>hasMetadata<span class="signature">(key)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> <p>Retrieves whether this type has specific metadata</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#hasMetadata">metamodel.Attribute#hasMetadata</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line98">line 98</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">(declaringType, order)</span><span class="type-signature"> → {void}</span></h4> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>declaringType</code></td> <td class="type"> <span class="param-type"><a href="metamodel.ManagedType.html">metamodel.ManagedType</a></span> </td> <td class="description last"><p>The type that owns this attribute</p></td> </tr> <tr> <td class="name"><code>order</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>Position of the attribute</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#init">metamodel.Attribute#init</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line65">line 65</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id="setJsonValue"><span class="type-signature">(abstract) </span>setJsonValue<span class="signature">(state, object, jsonValue, options)</span><span class="type-signature"> → {void}</span></h4> <div class="description"> <p>Sets this attribute value from json to the object</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>state</code></td> <td class="type"> <span class="param-type"><a href="util.Metadata.html">util.Metadata</a></span> </td> <td class="description last"><p>The root state</p></td> </tr> <tr> <td class="name"><code>object</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="description last"><p>The object which contains the attribute</p></td> </tr> <tr> <td class="name"><code>jsonValue</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="description last"><p>The json value to convert an set</p></td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>additional options which are applied through the conversion</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#setJsonValue">metamodel.Attribute#setJsonValue</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line135">line 135</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id="setValue"><span class="type-signature"></span>setValue<span class="signature">(entity, value)</span><span class="type-signature"> → {void}</span></h4> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>entity</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#setValue">metamodel.Attribute#setValue</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line88">line 88</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON<span class="signature">()</span><span class="type-signature"> → {json}</span></h4> <div class="description"> <p>Converts this attribute field to json</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="metamodel.Attribute.html#toJSON">metamodel.Attribute#toJSON</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_metamodel_Attribute.js.html">lib/metamodel/Attribute.js</a>, <a href="lib_metamodel_Attribute.js.html#line141">line 141</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The attribute description as json</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">json</span> </dd> </dl> </article> </section>  </div> </div> </div> </div> </div> <div id="footer" style="position:relative; z-index:1;"> <div class="container"> <div