cla-wrapper
Version:
Wrapper for CDISC Library API
760 lines • 42.3 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ProductClass | 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.ProductClass.html">ProductClass</a>
</li>
</ul>
<h1>Class ProductClass</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>Product class</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BasicFunctions</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">ProductClass</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.ProductClass.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.ProductClass.html#coreObject" class="tsd-kind-icon">core<wbr>Object</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.ProductClass.html#href" class="tsd-kind-icon">href</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="claWrapper.ProductClass.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="claWrapper.ProductClass.html#productGroups" class="tsd-kind-icon">product<wbr>Groups</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"><a href="claWrapper.ProductClass.html#getItemGroup" class="tsd-kind-icon">get<wbr>Item<wbr>Group</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="claWrapper.ProductClass.html#getItemGroups" class="tsd-kind-icon">get<wbr>Item<wbr>Groups</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="claWrapper.ProductClass.html#getProductGroup" class="tsd-kind-icon">get<wbr>Product<wbr>Group</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="claWrapper.ProductClass.html#getProductGroupList" class="tsd-kind-icon">get<wbr>Product<wbr>Group<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="claWrapper.ProductClass.html#getProductGroups" class="tsd-kind-icon">get<wbr>Product<wbr>Groups</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="claWrapper.ProductClass.html#getProductIdByAlias" class="tsd-kind-icon">get<wbr>Product<wbr>IdBy<wbr>Alias</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="claWrapper.ProductClass.html#getProductList" class="tsd-kind-icon">get<wbr>Product<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="claWrapper.ProductClass.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.ProductClass.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="claWrapper.ProductClass.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.ProductClass.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>Product<wbr>Class<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>coreObject<span class="tsd-signature-symbol">?: </span><a href="claWrapper.CoreObject.html" class="tsd-signature-type" data-tsd-kind="Class">CoreObject</a><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>productGroups<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="claWrapper.ProductClass.html" class="tsd-signature-type" data-tsd-kind="Class">ProductClass</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides BasicFunctions.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L684">claWrapper.ts:684</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>coreObject<span class="tsd-signature-symbol">?: </span><a href="claWrapper.CoreObject.html" class="tsd-signature-type" data-tsd-kind="Class">CoreObject</a><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>productGroups<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> core<wbr>Object<span class="tsd-signature-symbol">?: </span><a href="claWrapper.CoreObject.html" class="tsd-signature-type" data-tsd-kind="Class">CoreObject</a></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> product<wbr>Groups<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="claWrapper.ProductGroup.html" class="tsd-signature-type" data-tsd-kind="Class">ProductGroup</a></h5>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="claWrapper.ProductClass.html" class="tsd-signature-type" data-tsd-kind="Class">ProductClass</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="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 BasicFunctions.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 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 BasicFunctions.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">
<a name="name" class="tsd-anchor"></a>
<h3>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">
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L681">claWrapper.ts:681</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Product class name.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="productGroups" class="tsd-anchor"></a>
<h3>product<wbr>Groups</h3>
<div class="tsd-signature tsd-kind-icon">product<wbr>Groups<span class="tsd-signature-symbol">:</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#L683">claWrapper.ts:683</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An object with Product Groups.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="claWrapper.ProductGroup.html" class="tsd-signature-type" data-tsd-kind="Class">ProductGroup</a></h5>
</li>
</ul>
</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">
<a name="getItemGroup" class="tsd-anchor"></a>
<h3>get<wbr>Item<wbr>Group</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Item<wbr>Group<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, productAlias<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GetItemGroupOptions</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">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ItemGroupType</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L780">claWrapper.ts:780</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a dataset/dataStructure/domain for a specific product</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Dataset name</p>
</div>
</li>
<li>
<h5>productAlias: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Product name alias. Examples: sdtmig3-3, sdtm1.7, adamig11.</p>
</div>
</li>
<li>
<h5>options: <span class="tsd-signature-type">GetItemGroupOptions</span></h5>
<div class="tsd-comment tsd-typography">
<p>@GetItemGroupOptions</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">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ItemGroupType</span><span class="tsd-signature-symbol">></span></h4>
<p>Dataset/DataStruture/Domain</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getItemGroups" class="tsd-anchor"></a>
<h3>get<wbr>Item<wbr>Groups</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Item<wbr>Groups<span class="tsd-signature-symbol">(</span>productAlias<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GetItemGroupsOptions</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">ItemGroups</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L802">claWrapper.ts:802</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get an object with all datasets/domains/dataStructure
<br> This method does not update the main object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>productAlias: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Product alias</p>
</div>
</li>
<li>
<h5>options: <span class="tsd-signature-type">GetItemGroupsOptions</span></h5>
<div class="tsd-comment tsd-typography">
<p>@GetItemGroupsOptions</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">ItemGroups</span><span class="tsd-signature-symbol">></span></h4>
<p>An object with datasets/domains/dataStructures
<br> In case options.short is set to true, only name and label for each itemGroup are returned.
This approach does not load the full product and loads only the dataset information from the CDISC Library.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getProductGroup" class="tsd-anchor"></a>
<h3>get<wbr>Product<wbr>Group</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Product<wbr>Group<span class="tsd-signature-symbol">(</span>name<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><a href="claWrapper.ProductGroup.html" class="tsd-signature-type" data-tsd-kind="Class">ProductGroup</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L744">claWrapper.ts:744</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a product group</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Valid product group name.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="claWrapper.ProductGroup.html" class="tsd-signature-type" data-tsd-kind="Class">ProductGroup</a></h4>
<p>Product group or a blank</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getProductGroupList" class="tsd-anchor"></a>
<h3>get<wbr>Product<wbr>Group<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Product<wbr>Group<wbr>List<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L730">claWrapper.ts:730</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a list of product group names</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4>
<p>Array of product group names</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getProductGroups" class="tsd-anchor"></a>
<h3>get<wbr>Product<wbr>Groups</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Product<wbr>Groups<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L717">claWrapper.ts:717</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get an object with product groups</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{}</span></h4>
<p>Product groups</p>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="claWrapper.ProductGroup.html" class="tsd-signature-type" data-tsd-kind="Class">ProductGroup</a></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getProductIdByAlias" class="tsd-anchor"></a>
<h3>get<wbr>Product<wbr>IdBy<wbr>Alias</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Product<wbr>IdBy<wbr>Alias<span class="tsd-signature-symbol">(</span>alias<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-symbol">{ </span>productGroupId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>productId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L820">claWrapper.ts:820</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a product, product group IDs by alias or substring, e.g., adamig11 agamig1-1 adamig1.1 will return { productGroupId: 'adam', productId: 'adamig-1-1' }.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>alias: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Product name alias</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>productGroupId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>productId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4>
<p>Product and product group IDs</p>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>product<wbr>Group<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>product<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getProductList" class="tsd-anchor"></a>
<h3>get<wbr>Product<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Product<wbr>List<span class="tsd-signature-symbol">(</span>format<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"json"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"csv"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L763">claWrapper.ts:763</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a list of product IDs</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>format: <span class="tsd-signature-type">"json"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"csv"</span><span class="tsd-signature-symbol"> = 'json'</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></h4>
<p>List of product names (IDs)</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 BasicFunctions.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 BasicFunctions.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-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>pcRaw<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, name<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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides BasicFunctions.parseResponse</p>
<ul>
<li>Defined in <a href="https://github.com/defineEditor/cla-wrapper/blob/0723d63/src/classes/claWrapper.ts#L697">claWrapper.ts:697</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Parse API response to product classes</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>pcRaw: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Raw CDISC API response.</p>
</div>
</li>
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Product class name.</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 BasicFunctions.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>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.ProductClass.html" class="tsd-kind-icon">Product<wbr>Class</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="claWrapper.ProductClass.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.ProductClass.html#coreObject" class="tsd-kind-icon">core<wbr>Object</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.ProductClass.html#href" class="tsd-kind-icon">href</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="claWrapper.ProductClass.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="claWrapper.ProductClass.html#productGroups" class="tsd-kind-icon">product<wbr>Groups</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="claWrapper.ProductClass.html#getItemGroup" class="tsd-kind-icon">get<wbr>Item<wbr>Group</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="claWrapper.ProductClass.html#getItemGroups" class="tsd-kind-icon">get<wbr>Item<wbr>Groups</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="claWrapper.ProductClass.html#getProductGroup" class="tsd-kind-icon">get<wbr>Product<wbr>Group</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="claWrapper.ProductClass.html#getProductGroupList" class="tsd-kind-icon">get<wbr>Product<wbr>Group<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="claWrapper.ProductClass.html#getProductGroups" class="tsd-kind-icon">get<wbr>Product<wbr>Groups</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="claWrapper.ProductClass.html#getProductIdByAlias" class="tsd-kind-icon">get<wbr>Product<wbr>IdBy<wbr>Alias</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="claWrapper.ProductClass.html#getProductList" class="tsd-kind-icon">get<wbr>Product<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="claWrapper.ProductClass.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.ProductClass.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="claWrapper.ProductClass.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.ProductClass.html#toSimpleObject" class="tsd-kind-icon">to<wbr>Simple<wbr>Object</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<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>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="claWrapper.Variable.html" class="tsd-kind-icon">Variable</a>
</li>
<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>