@harishreddym/baqend
Version:
Baqend JavaScript SDK
3,239 lines (890 loc) • 64.5 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Baqend JavaScript SDK 2.14.1 - Class: ManagedType</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<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">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<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>
<!-- Main title -->
<a class="navbar-brand" href="/"><img src="img/logo.png"></a>
</div>
<!-- Expanded navigation -->
<div id="nav" class="navbar-collapse collapse">
<!-- Search -->
<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>
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li>
<a href="https://dashboard.baqend.com/">Dashboard</a>
</li>
<!-- Guide Navigation -->
<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>
<!-- Starter Kits -->
<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="col-md-3"></div> -->
<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=""><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="active"><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: ManagedType</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>
<span class="ancestors"><a href="metamodel.html">metamodel</a>.</span>ManagedType<span class="signature">(ref, typeConstructor<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="ManagedType"><span class="type-signature"></span>new ManagedType<span class="signature">(ref, typeConstructor<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<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>ref</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>or full class name</p></td>
</tr>
<tr>
<td class="name"><code>typeConstructor</code></td>
<td class="type">
<span class="param-type">Class.<binding.Managed></span>
</td>
<td class="attributes">
<optional><br>
</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_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line16">line 16</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="metamodel.Type.html">metamodel.Type</a></li>
</ul>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="declaredAttributes"><span class="type-signature"></span>declaredAttributes<span class="type-signature"> :Array.<metamodel.Attribute></span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<metamodel.Attribute></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line78">line 78</a>
</li></ul></dd>
</dl>
<h4 class="name" id="enhancer"><span class="type-signature"></span>enhancer<span class="type-signature"> :<a href="binding.Enhancer.html">binding.Enhancer</a></span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="binding.Enhancer.html">binding.Enhancer</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line76">line 76</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isBasic"><span class="type-signature">(readonly) </span>isBasic<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.Type.html#isBasic">metamodel.Type#isBasic</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_Type.js.html">lib/metamodel/Type.js</a>, <a href="lib_metamodel_Type.js.html#line23">line 23</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isEmbeddable"><span class="type-signature">(readonly) </span>isEmbeddable<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.Type.html#isEmbeddable">metamodel.Type#isEmbeddable</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_Type.js.html">lib/metamodel/Type.js</a>, <a href="lib_metamodel_Type.js.html#line31">line 31</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isEntity"><span class="type-signature">(readonly) </span>isEntity<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.Type.html#isEntity">metamodel.Type#isEntity</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_Type.js.html">lib/metamodel/Type.js</a>, <a href="lib_metamodel_Type.js.html#line39">line 39</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isMappedSuperclass"><span class="type-signature">(readonly) </span>isMappedSuperclass<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.Type.html#isMappedSuperclass">metamodel.Type#isMappedSuperclass</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_Type.js.html">lib/metamodel/Type.js</a>, <a href="lib_metamodel_Type.js.html#line47">line 47</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="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line86">line 86</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.Type.html#name">metamodel.Type#name</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_Type.js.html">lib/metamodel/Type.js</a>, <a href="lib_metamodel_Type.js.html#line80">line 80</a>
</li></ul></dd>
</dl>
<h4 class="name" id="persistenceType"><span class="type-signature">(abstract, readonly) </span>persistenceType<span class="type-signature"> :number</span></h4>
<div class="description">
<p>The persistent type of this type</p>
</div>
<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.Type.html#persistenceType">metamodel.Type#persistenceType</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_Type.js.html">lib/metamodel/Type.js</a>, <a href="lib_metamodel_Type.js.html#line15">line 15</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ref"><span class="type-signature"></span>ref<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.Type.html#ref">metamodel.Type#ref</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_Type.js.html">lib/metamodel/Type.js</a>, <a href="lib_metamodel_Type.js.html#line78">line 78</a>
</li></ul></dd>
</dl>
<h4 class="name" id="schemaAddPermission"><span class="type-signature"></span>schemaAddPermission<span class="type-signature"> :<a href="util.Permission.html">util.Permission</a></span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="util.Permission.html">util.Permission</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line81">line 81</a>
</li></ul></dd>
</dl>
<h4 class="name" id="schemaReplacePermission"><span class="type-signature"></span>schemaReplacePermission<span class="type-signature"> :<a href="util.Permission.html">util.Permission</a></span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="util.Permission.html">util.Permission</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line83">line 83</a>
</li></ul></dd>
</dl>
<h4 class="name" id="typeConstructor"><span class="type-signature"></span>typeConstructor<span class="type-signature"> :Class.<binding.Managed></span></h4>
<div class="description">
<p>The Managed class</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Class.<binding.Managed></span>
</li>
</ul>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="metamodel.Type.html#typeConstructor">metamodel.Type#typeConstructor</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line39">line 39</a>
</li></ul></dd>
</dl>
<h4 class="name" id="typeConstructor"><span class="type-signature"></span>typeConstructor<span class="type-signature"></span></h4>
<div class="description">
<p>The Managed class constructor</p>
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="metamodel.Type.html#typeConstructor">metamodel.Type#typeConstructor</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line50">line 50</a>
</li></ul></dd>
</dl>
<h4 class="name" id="validationCode"><span class="type-signature"></span>validationCode<span class="type-signature"> :function</span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">function</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line20">line 20</a>
</li></ul></dd>
</dl>
<h4 class="name" id="validationCode"><span class="type-signature"></span>validationCode<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_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line27">line 27</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="addAttribute"><span class="type-signature"></span>addAttribute<span class="signature">(attr, order<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {void}</span></h4>
<div class="description">
<p>Adds an attribute to this type</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>attr</code></td>
<td class="type">
<span class="param-type"><a href="metamodel.Attribute.html">metamodel.Attribute</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The attribute to add</p></td>
</tr>
<tr>
<td class="name"><code>order</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>Position of the attribute</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_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line181">line 181</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="attributes"><span class="type-signature"></span>attributes<span class="signature">()</span><span class="type-signature"> → {Iterator.<metamodel.Attribute>}</span></h4>
<div class="description">
<p>An iterator which returns all attributes declared by this type and inherited form all super types</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line135">line 135</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Iterator.<metamodel.Attribute></span>
</dd>
</dl>
<h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">()</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
<p>Creates a new instance of the managed type, without invoking any constructors</p>
<p>This method is used to create object instances which are loaded form the backend.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line124">line 124</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The created instance</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="createObjectFactory"><span class="type-signature">(abstract) </span>createObjectFactory<span class="signature">(db)</span><span class="type-signature"> → {<a href="binding.ManagedFactory.html">binding.ManagedFactory.<*></a>}</span></h4>
<div class="description">
<p>Creates an ObjectFactory for this type and the given EntityManager</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>db</code></td>
<td class="type">
<span class="param-type"><a href="EntityManager.html">EntityManager</a></span>
</td>
<td class="description last"><p>The created instances will be attached to this EntityManager</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_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line115">line 115</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>the crated object factory for the given EntityManager</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="binding.ManagedFactory.html">binding.ManagedFactory.<*></a></span>
</dd>
</dl>
<h4 class="name" id="createProxyClass"><span class="type-signature">(abstract) </span>createProxyClass<span class="signature">()</span><span class="type-signature"> → {Class.<*>}</span></h4>
<div class="description">
<p>Creates an ProxyClass for this type</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line107">line 107</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>the crated proxy class for this type</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Class.<*></span>
</dd>
</dl>
<h4 class="name" id="fromJsonValue"><span class="type-signature"></span>fromJsonValue<span class="signature">(state, jsonValue, currentValue, options)</span><span class="type-signature"> → {*}</span></h4>
<div class="description">
<p>Merge the json data into the current object instance and returns the merged 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 object state</p></td>
</tr>
<tr>
<td class="name"><code>jsonValue</code></td>
<td class="type">
<span class="param-type">json</span>
</td>
<td class="description last"><p>The json data to merge</p></td>
</tr>
<tr>
<td class="name"><code>currentValue</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"><p>The object where the jsonObject will be merged into, if the current object is null,<br> a new instance will be created</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>
<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>onlyMetadata</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 that only the metadata should be updated of the object</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="metamodel.Type.html#fromJsonValue">metamodel.Type#fromJsonValue</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_Type.js.html">lib/metamodel/Type.js</a>, <a href="lib_metamodel_Type.js.html#line95">line 95</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The merged object instance</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">*</span>
</dd>
</dl>
<h4 class="name" id="getAttribute"><span class="type-signature"></span>getAttribute<span class="signature">(name<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {<a href="metamodel.Attribute.html">metamodel.Attribute</a>}</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>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line219">line 219</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="metamodel.Attribute.html">metamodel.Attribute</a></span>
</dd>
</dl>
<h4 class="name" id="getDeclaredAttribute"><span class="type-signature"></span>getDeclaredAttribute<span class="signature">(val)</span><span class="type-signature"> → {<a href="metamodel.Attribute.html">metamodel.Attribute</a>}</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>val</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">number</span>
</td>
<td class="description last"><p>Name or order of the attribute</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_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line233">line 233</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="metamodel.Attribute.html">metamodel.Attribute</a></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="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_metamodel_ManagedType.js.html">lib/metamodel/ManagedType.js</a>, <a href="lib_metamodel_ManagedType.js.html#line375">line 375</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="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>