doc/Transformer.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: Transformer</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 type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">
    
    <h1 class="page-title">Class: Transformer</h1>
    
    
<section>
    
<header>
    <h2>
    Transformer
    </h2>
    
</header>  

<article>
    <div class="container-overview">
    
    
<dt>
    <h4 class="name" id="Transformer"><span class="type-signature"></span>new Transformer<span class="signature">(request)</span><span class="type-signature"> &rarr; {<a href="Transformer.html">Transformer</a>}</span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Transformer Class
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>request</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">object</span>


            </td>
            
            
            <td class="description last">The body of the HTTP Post request from the client</td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="transform.js.html">transform.js</a>, line 4
    </li></ul></dd>
    
    
</dl>

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    A new instance of Transformer
</div>


<dl>
	<dt>
		Type
	</dt>
	<dd>
		
<span class="param-type"><a href="Transformer.html">Transformer</a></span>


	</dd>
</dl>

        
</dd>

    
    </div>
    
    
        <h3 class="subsection-title">Methods</h3>
        
        <dl>
            
<dt>
    <h4 class="name" id="generateReply"><span class="type-signature">&lt;static> </span>TransformRequest#generateReply<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Wrapper for `NetsuiteToolkit.formatReply()`
    </div>
    

<dl class="details">
    
        
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="transform.js.html">transform.js</a>, line 149
    </li></ul></dd>
    
    
</dl>

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    The formatted reply from Netsuite
</div>


<dl>
	<dt>
		Type
	</dt>
	<dd>
		
<span class="param-type">object</span>


	</dd>
</dl>

        
</dd>

        
<dt>
    <h4 class="name" id="accumulateResult"><span class="type-signature"></span>accumulateResult<span class="signature">(The)</span><span class="type-signature"> &rarr; {null}</span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Adds a result to the `reply_list`
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>The</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">object</span>


            </td>
            
            
            <td class="description last">result</td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="transform.js.html">transform.js</a>, line 56
    </li></ul></dd>
    
    
</dl>

    
    <h5>Returns:</h5>
    
            
<dl>
	<dt>
		Type
	</dt>
	<dd>
		
<span class="param-type">null</span>


	</dd>
</dl>

        
</dd>

        
<dt>
    <h4 class="name" id="executeTransformRequest"><span class="type-signature"></span>executeTransformRequest<span class="signature">(The)</span><span class="type-signature"> &rarr; {null}</span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Executes a new TransformRequest, accumulating the result
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>The</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">object</span>


            </td>
            
            
            <td class="description last">request data</td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="transform.js.html">transform.js</a>, line 42
    </li></ul></dd>
    
    
</dl>

    
    <h5>Returns:</h5>
    
            
<dl>
	<dt>
		Type
	</dt>
	<dd>
		
<span class="param-type">null</span>


	</dd>
</dl>

        
</dd>

        
<dt>
    <h4 class="name" id="generateReply"><span class="type-signature"></span>generateReply<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Wrapper for `NetsuiteToolkit.formatReply()`
    </div>
    

<dl class="details">
    
        
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="transform.js.html">transform.js</a>, line 67
    </li></ul></dd>
    
    
</dl>

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    The formatted reply from Netsuite
</div>


<dl>
	<dt>
		Type
	</dt>
	<dd>
		
<span class="param-type">object</span>


	</dd>
</dl>

        
</dd>

        
<dt>
    <h4 class="name" id="transformRecords"><span class="type-signature"></span>transformRecords<span class="signature">()</span><span class="type-signature"> &rarr; {null}</span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Iterates over each record calling `executeTransformRequest()`
    </div>
    

<dl class="details">
    
        
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="transform.js.html">transform.js</a>, line 27
    </li></ul></dd>
    
    
</dl>

    
    <h5>Returns:</h5>
    
            
<dl>
	<dt>
		Type
	</dt>
	<dd>
		
<span class="param-type">null</span>


	</dd>
</dl>

        
</dd>

        </dl>
    
    
</article>

</section>  


</div>

<nav>
    <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Deleter.html">Deleter</a></li><li><a href="DeleteRequest.html">DeleteRequest</a></li><li><a href="Initializer.html">Initializer</a></li><li><a href="Loader.html">Loader</a></li><li><a href="LoadRequest.html">LoadRequest</a></li><li><a href="NetsuiteToolkit.SublistProcessor.html">SublistProcessor</a></li><li><a href="SavedSearch.html">SavedSearch</a></li><li><a href="Searcher.html">Searcher</a></li><li><a href="Transformer.html">Transformer</a></li><li><a href="TransformRequest.html">TransformRequest</a></li><li><a href="Upserter.html">Upserter</a></li><li><a href="UpsertRequest.html">UpsertRequest</a></li></ul><h3>Namespaces</h3><ul><li><a href="global.html">global</a></li><li><a href="NetsuiteToolkit.html">NetsuiteToolkit</a></li><li><a href="NetsuiteToolkit.RecordProcessor.html">RecordProcessor</a></li></ul>
</nav>

<br clear="both">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.1.1</a> on Thu May 16 2013 11:16:10 GMT-0500 (CDT)
</footer>

<script> prettyPrint(); </script>
</body>
</html>