@harishreddym/baqend

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Baqend JavaScript SDK 2.14.1 - Class: Metadata</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=""> <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=""><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="active"> <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="active"><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: Metadata</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span> <span class="ancestors"><a href="util.html">util</a>.</span>Metadata<span class="signature">(entity, type)</span><span class="type-signature"></span></h2> <div class="class-description"><p>The Metadata instance tracks the state of an object and checks if the object state was changed since last<br>load/update. The metadata keeps therefore the state of:</p> <ul> <li>in which state the object currently is</li> <li>which db managed the instance</li> <li>the metadata of the object (id, version, bucket)</li> <li>which is the owning object (root object) of an embedded object</li> </ul> <p><code>util.Metadata#get(object)</code> can be used on any managed object to retrieve the metadata of the root object</p></div> </header> <article> <div class="container-overview"> <h2>Constructor</h2> <h4 class="name" id="Metadata"><span class="type-signature"></span>new Metadata<span class="signature">(entity, type)</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"><a href="binding.Entity.html">binding.Entity</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type"><a href="metamodel.ManagedType.html">metamodel.ManagedType</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_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line21">line 21</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Extends</h3> <ul> <li><a href="util.Lockable.html">util.Lockable</a></li> </ul> <h3 class="subsection-title">Members</h3> <h4 class="name" id=".Type"><span class="type-signature">(static) </span>Type<span class="type-signature"> :number</span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>UNAVAILABLE</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>PERSISTENT</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>DIRTY</code></td> <td class="type"> <span class="param-type">number</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_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line296">line 296</a> </li></ul></dd> </dl> <h4 class="name" id="acl"><span class="type-signature"></span>acl<span class="type-signature"> :<a href="Acl.html">Acl</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="Acl.html">Acl</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line180">line 180</a> </li></ul></dd> </dl> <h4 class="name" id="bucket"><span class="type-signature">(readonly) </span>bucket<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="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line92">line 92</a> </li></ul></dd> </dl> <h4 class="name" id="db"><span class="type-signature"></span>db<span class="type-signature"> :<a href="EntityManager.html">EntityManager</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="EntityManager.html">EntityManager</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line68">line 68</a> </li></ul></dd> </dl> <h4 class="name" id="db"><span class="type-signature"></span>db<span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line80">line 80</a> </li></ul></dd> </dl> <h4 class="name" id="id"><span class="type-signature"></span>id<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="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line174">line 174</a> </li></ul></dd> </dl> <h4 class="name" id="isAttached"><span class="type-signature">(readonly) </span>isAttached<span class="type-signature"> :boolean</span></h4> <div class="description"> <p>Indicates if this object already belongs to an db<br><code>true</code> if this object belongs already to an db otherwise <code>false</code></p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line128">line 128</a> </li></ul></dd> </dl> <h4 class="name" id="isAvailable"><span class="type-signature">(readonly) </span>isAvailable<span class="type-signature"> :boolean</span></h4> <div class="description"> <p>Indicates if this object is represents a db object, but was not loaded up to now</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line137">line 137</a> </li></ul></dd> </dl> <h4 class="name" id="isDirty"><span class="type-signature">(readonly) </span>isDirty<span class="type-signature"> :boolean</span></h4> <div class="description"> <p>Indicates that this object was modified and the object was not written back to the db</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line155">line 155</a> </li></ul></dd> </dl> <h4 class="name" id="isPersistent"><span class="type-signature">(readonly) </span>isPersistent<span class="type-signature"> :boolean</span></h4> <div class="description"> <p>Indicates if this object represents the state of the db and was not modified in any manner</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line146">line 146</a> </li></ul></dd> </dl> <h4 class="name" id="isReady"><span class="type-signature"></span>isReady<span class="type-signature"> :boolean</span></h4> <div class="description"> <p>Indicates if there is currently no exclusive operation executed<br><code>true</code> If no exclusive lock is hold</p> </div> <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="util.Lockable.html#isReady">util.Lockable#isReady</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Lockable.js.html">lib/util/Lockable.js</a>, <a href="lib_util_Lockable.js.html#line34">line 34</a> </li></ul></dd> </dl> <h4 class="name" id="key"><span class="type-signature">(readonly) </span>key<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="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line100">line 100</a> </li></ul></dd> </dl> <h4 class="name" id="key"><span class="type-signature"></span>key<span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line111">line 111</a> </li></ul></dd> </dl> <h4 class="name" id="type"><span class="type-signature"></span>type<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="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line178">line 178</a> </li></ul></dd> </dl> <h4 class="name" id="version"><span class="type-signature"></span>version<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="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line176">line 176</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id=".create"><span class="type-signature">(static) </span>create<span class="signature">(type, object)</span><span class="type-signature"> → {*}</span></h4> <div class="description"> <p>Creates a metadata instance for the given type and object instance</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>type</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 of the object</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 instance of the type</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line29">line 29</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The created metadata for the object</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">*</span> </dd> </dl> <h4 class="name" id=".get"><span class="type-signature">(static) </span>get<span class="signature">(managed)</span><span class="type-signature"> → {<a href="util.Metadata.html">util.Metadata</a>}</span></h4> <div class="description"> <p>Returns the metadata of the managed 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>managed</code></td> <td class="type"> <span class="param-type"><a href="binding.Managed.html">binding.Managed</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_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line61">line 61</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="util.Metadata.html">util.Metadata</a></span> </dd> </dl> <h4 class="name" id="enable"><span class="type-signature"></span>enable<span class="signature">(newStateTrackingState)</span><span class="type-signature"> → {void}</span></h4> <div class="description"> <p>Enable/Disable state change tracking of this 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>newStateTrackingState</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>The new change tracking state</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line188">line 188</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="getJson"><span class="type-signature"></span>getJson<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {json}</span></h4> <div class="description"> <p>Converts the object to an JSON-Object</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> | <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>to json options by default excludes the metadata</p></td> </tr> <tr> <td colspan="4" class="subparams"> <h6>Properties</h6> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>excludeMetadata</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>Excludes the metadata form the serialized json</p></td> </tr> <tr> <td class="name"><code>depth</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>Includes up to depth referenced objects into the serialized json</p></td> </tr> <tr> <td class="name"><code>persisting</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>indicates if the current state will be persisted.<br> Used to update the internal change tracking state of collections and mark the object persistent if its true</p></td> </tr> </tbody> </table> </td> </tr> </tbody> </table> <dl class="details"> <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line273">line 273</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>JSON-Object</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">json</span> </dd> </dl> <h4 class="name" id="readAccess"><span class="type-signature"></span>readAccess<span class="signature">()</span><span class="type-signature"> → {void}</span></h4> <div class="description"> <p>Signals that the object will be accessed by a read</p> <p>Ensures that the object was loaded already.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line199">line 199</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="ready"><span class="type-signature"></span>ready<span class="signature">(doneCallback<span class="signature-attributes">opt</span>, failCallback<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<this>}</span></h4> <div class="description"> <p>Waits on the previously requested operation and calls the doneCallback if the operation is fulfilled</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>doneCallback</code></td> <td class="type"> <span class="param-type"><a href="util.Lockable.html#~doneCallback">util.Lockable~doneCallback</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The callback which will be invoked when the previously<br>operations on this object is completed.</p></td> </tr> <tr> <td class="name"><code>failCallback</code></td> <td class="type"> <span class="param-type"><a href="util.Lockable.html#~failCallback">util.Lockable~failCallback</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>When the lock can't be released caused by a none<br>recoverable error</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="util.Lockable.html#ready">util.Lockable#ready</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Lockable.js.html">lib/util/Lockable.js</a>, <a href="lib_util_Lockable.js.html#line47">line 47</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>A promise which completes successfully, when the previously requested<br>operation completes</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<this></span> </dd> </dl> <h4 class="name" id="setDirty"><span class="type-signature"></span>setDirty<span class="signature">()</span><span class="type-signature"> → {void}</span></h4> <div class="description"> <p>Indicates the the object is modified by the user</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Metadata.js.html">lib/util/Metadata.js</a>, <a href="lib_util_Metadata.js.html#line247">line 247</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="setJson"><span class="type-signature"></span>setJson<span class="signature">(json, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {void}</span></h4> <div class="description"> <p>Sets the object content from json</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>json</code></td> <td class="type"> <span class="param-type">json</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The updated json content</p></td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>The options used to apply the json</p></td> </tr> <tr> <td colspan="4" class="subparams"> <h6>Properties</h6> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>persisting</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>indicates if the current state will be persisted.<br>Used to update the internal change tracking state of collections and mark the object persistent or dirty afterwards</p></td> </tr>