cla-wrapper
Version:
Wrapper for CDISC Library API
766 lines • 40.3 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Variable | cla-wrapper</title>
<meta name="description" content="Documentation for cla-wrapper">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">cla-wrapper</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">cla-wrapper</a>
</li>
<li>
<a href="../modules/claWrapper.html">claWrapper</a>
</li>
<li>
<a href="claWrapper.Variable.html">Variable</a>
</li>
</ul>
<h1>Class Variable</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Variable class</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">Item</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">Variable</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="claWrapper.Variable.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.Variable.html#codelist" class="tsd-kind-icon">codelist</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.Variable.html#codelistHref" class="tsd-kind-icon">codelist<wbr>Href</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="claWrapper.Variable.html#core" class="tsd-kind-icon">core</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.Variable.html#coreObject" class="tsd-kind-icon">core<wbr>Object</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="claWrapper.Variable.html#describedValueDomain" class="tsd-kind-icon">described<wbr>Value<wbr>Domain</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="claWrapper.Variable.html#description" class="tsd-kind-icon">description</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.Variable.html#href" class="tsd-kind-icon">href</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.Variable.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.Variable.html#label" class="tsd-kind-icon">label</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.Variable.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.Variable.html#ordinal" class="tsd-kind-icon">ordinal</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="claWrapper.Variable.html#role" class="tsd-kind-icon">role</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="claWrapper.Variable.html#roleDescription" class="tsd-kind-icon">role<wbr>Description</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.Variable.html#simpleDatatype" class="tsd-kind-icon">simple<wbr>Datatype</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.Variable.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="claWrapper.Variable.html#valueList" class="tsd-kind-icon">value<wbr>List</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.Variable.html#getCodeList" class="tsd-kind-icon">get<wbr>Code<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.Variable.html#getRawResponse" class="tsd-kind-icon">get<wbr>Raw<wbr>Response</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.Variable.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.Variable.html#parseItemResponse" class="tsd-kind-icon">parse<wbr>Item<wbr>Response</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="claWrapper.Variable.html#parseResponse" class="tsd-kind-icon">parse<wbr>Response</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.Variable.html#toSimpleObject" class="tsd-kind-icon">to<wbr>Simple<wbr>Object</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Variable<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">VariableParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="claWrapper.Variable.html" class="tsd-signature-type" data-tsd-kind="Class">Variable</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides Item.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2803">claWrapper.ts:2803</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <span class="tsd-signature-type">VariableParameters</span><span class="tsd-signature-symbol"> = {}</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="claWrapper.Variable.html" class="tsd-signature-type" data-tsd-kind="Class">Variable</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="codelist" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> codelist</h3>
<div class="tsd-signature tsd-kind-icon">codelist<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from Item.codelist</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2676">claWrapper.ts:2676</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute. C-Code of the codelist.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="codelistHref" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> codelist<wbr>Href</h3>
<div class="tsd-signature tsd-kind-icon">codelist<wbr>Href<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from Item.codelistHref</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2678">claWrapper.ts:2678</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="core" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> core</h3>
<div class="tsd-signature tsd-kind-icon">core<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2793">claWrapper.ts:2793</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="coreObject" class="tsd-anchor"></a>
<h3>core<wbr>Object</h3>
<div class="tsd-signature tsd-kind-icon">core<wbr>Object<span class="tsd-signature-symbol">:</span> <a href="claWrapper.CoreObject.html" class="tsd-signature-type" data-tsd-kind="Class">CoreObject</a></div>
<aside class="tsd-sources">
<p>Inherited from Item.coreObject</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L149">claWrapper.ts:149</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CLA Wrapper attribute. Object used to send API requests and store technical information. Must be the same object for all classes within an instance of a CdiscLibrary class.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="describedValueDomain" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> described<wbr>Value<wbr>Domain</h3>
<div class="tsd-signature tsd-kind-icon">described<wbr>Value<wbr>Domain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2801">claWrapper.ts:2801</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="description" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2791">claWrapper.ts:2791</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="href" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> href</h3>
<div class="tsd-signature tsd-kind-icon">href<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from Item.href</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L147">claWrapper.ts:147</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library API endpoint.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from Item.id</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2666">claWrapper.ts:2666</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="label" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> label</h3>
<div class="tsd-signature tsd-kind-icon">label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from Item.label</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2672">claWrapper.ts:2672</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from Item.name</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2670">claWrapper.ts:2670</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="ordinal" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ordinal</h3>
<div class="tsd-signature tsd-kind-icon">ordinal<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from Item.ordinal</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2668">claWrapper.ts:2668</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="role" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> role</h3>
<div class="tsd-signature tsd-kind-icon">role<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2795">claWrapper.ts:2795</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="roleDescription" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> role<wbr>Description</h3>
<div class="tsd-signature tsd-kind-icon">role<wbr>Description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2797">claWrapper.ts:2797</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute. In most cases identical to role, but in some cases contains further explanation of the role attribute.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="simpleDatatype" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> simple<wbr>Datatype</h3>
<div class="tsd-signature tsd-kind-icon">simple<wbr>Datatype<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from Item.simpleDatatype</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2674">claWrapper.ts:2674</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="type" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from Item.type</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2680">claWrapper.ts:2680</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute. Value of the _links.self.type.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="valueList" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> value<wbr>List</h3>
<div class="tsd-signature tsd-kind-icon">value<wbr>List<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2799">claWrapper.ts:2799</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDISC Library attribute.</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getCodeList" class="tsd-anchor"></a>
<h3>get<wbr>Code<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Code<wbr>List<span class="tsd-signature-symbol">(</span>ctVer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="claWrapper.CodeList.html" class="tsd-signature-type" data-tsd-kind="Class">CodeList</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from Item.getCodeList</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2735">claWrapper.ts:2735</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a Codelist object corresponding to the codelist used by the item.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>ctVer: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="claWrapper.CodeList.html" class="tsd-signature-type" data-tsd-kind="Class">CodeList</a><span class="tsd-signature-symbol">></span></h4>
<p>Instance of the CodeList class if item has a codelist.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getRawResponse" class="tsd-anchor"></a>
<h3>get<wbr>Raw<wbr>Response</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Raw<wbr>Response<span class="tsd-signature-symbol">(</span>href<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from Item.getRawResponse</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L162">claWrapper.ts:162</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get raw API response</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> href: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>CDISC Library API endpoint. If not specified, href attribute of the object is used.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
<p>Returns a JSON response if the request was successfull, otherwise returns undefined.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="load" class="tsd-anchor"></a>
<h3>load</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>href<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from Item.load</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L181">claWrapper.ts:181</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Load object from the CDISC Library</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> href: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>CDISC Library API endpoint. If not specified, href attribute of the object is used.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
<p>Returns true in the object was successfully loaded, false otherwise</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="parseItemResponse" class="tsd-anchor"></a>
<h3>parse<wbr>Item<wbr>Response</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">parse<wbr>Item<wbr>Response<span class="tsd-signature-symbol">(</span>itemRaw<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from Item.parseItemResponse</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2710">claWrapper.ts:2710</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Parse API response to item.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>itemRaw: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Raw CDISC API response.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="parseResponse" class="tsd-anchor"></a>
<h3>parse<wbr>Response</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">parse<wbr>Response<span class="tsd-signature-symbol">(</span>vRaw<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides Item.parseResponse</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L2821">claWrapper.ts:2821</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Parse API response to variable</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>vRaw: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Raw CDISC API response</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="toSimpleObject" class="tsd-anchor"></a>
<h3>to<wbr>Simple<wbr>Object</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>Simple<wbr>Object<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from Item.toSimpleObject</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L196">claWrapper.ts:196</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convert class to a simple object, removes methods and technical elements (e.g., coreObject).</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
<p>A new object</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/claWrapper.html">cla<wbr>Wrapper</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/searchResponse.html">search<wbr>Response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.AnalysisVariableSet.html" class="tsd-kind-icon">Analysis<wbr>Variable<wbr>Set</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.CdiscLibrary.html" class="tsd-kind-icon">Cdisc<wbr>Library</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.CodeList.html" class="tsd-kind-icon">Code<wbr>List</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.CoreObject.html" class="tsd-kind-icon">Core<wbr>Object</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.DataClass.html" class="tsd-kind-icon">Data<wbr>Class</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.DataStructure.html" class="tsd-kind-icon">Data<wbr>Structure</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.Dataset.html" class="tsd-kind-icon">Dataset</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.Domain.html" class="tsd-kind-icon">Domain</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.Field.html" class="tsd-kind-icon">Field</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.Product.html" class="tsd-kind-icon">Product</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.ProductClass.html" class="tsd-kind-icon">Product<wbr>Class</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.ProductGroup.html" class="tsd-kind-icon">Product<wbr>Group</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.Scenario.html" class="tsd-kind-icon">Scenario</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.Variable.html" class="tsd-kind-icon">Variable</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="claWrapper.Variable.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.Variable.html#codelist" class="tsd-kind-icon">codelist</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.Variable.html#codelistHref" class="tsd-kind-icon">codelist<wbr>Href</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="claWrapper.Variable.html#core" class="tsd-kind-icon">core</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.Variable.html#coreObject" class="tsd-kind-icon">core<wbr>Object</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="claWrapper.Variable.html#describedValueDomain" class="tsd-kind-icon">described<wbr>Value<wbr>Domain</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="claWrapper.Variable.html#description" class="tsd-kind-icon">description</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.Variable.html#href" class="tsd-kind-icon">href</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.Variable.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.Variable.html#label" class="tsd-kind-icon">label</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.Variable.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.Variable.html#ordinal" class="tsd-kind-icon">ordinal</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="claWrapper.Variable.html#role" class="tsd-kind-icon">role</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="claWrapper.Variable.html#roleDescription" class="tsd-kind-icon">role<wbr>Description</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.Variable.html#simpleDatatype" class="tsd-kind-icon">simple<wbr>Datatype</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.Variable.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="claWrapper.Variable.html#valueList" class="tsd-kind-icon">value<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.Variable.html#getCodeList" class="tsd-kind-icon">get<wbr>Code<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.Variable.html#getRawResponse" class="tsd-kind-icon">get<wbr>Raw<wbr>Response</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.Variable.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.Variable.html#parseItemResponse" class="tsd-kind-icon">parse<wbr>Item<wbr>Response</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="claWrapper.Variable.html#parseResponse" class="tsd-kind-icon">parse<wbr>Response</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.Variable.html#toSimpleObject" class="tsd-kind-icon">to<wbr>Simple<wbr>Object</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/claWrapper.html#ItemType" class="tsd-kind-icon">Item<wbr>Type</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>