easyappointments/doc/code/js/ServicesHelper.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: ServicesHelper</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: ServicesHelper</h1>

    
<section>

<header>
    
        <h2>
        ServicesHelper
        </h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
    <h2>Constructor</h2>
    

    <h4 class="name" id="ServicesHelper"><span class="type-signature"></span>new ServicesHelper<span class="signature">()</span><span class="type-signature"></span></h4>

    
<div class="description">
    This class contains the methods that will be used by the "Services" tab of the page.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="backend_services.js.html">backend_services.js</a>, <a href="backend_services.js.html#line107">line 107</a>
    </li></ul></dd>
    

</dl>


    </div>

    
        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id="delete"><span class="type-signature"></span>delete<span class="signature">(id)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Delete a service record from database.
</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>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">numeric</span>


            </td>

            
            <td class="description last">Record id to be deleted.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="backend_services.js.html">backend_services.js</a>, <a href="backend_services.js.html#line283">line 283</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="display"><span class="type-signature"></span>display<span class="signature">(service)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Display a service record into the service form.
</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>service</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            </td>

            
            <td class="description last">Contains the service record data.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="backend_services.js.html">backend_services.js</a>, <a href="backend_services.js.html#line353">line 353</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="filter"><span class="type-signature"></span>filter<span class="signature">(key, selectId, display)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Filters service records depending a string key.
</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>key</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">This is used to filter the service records of the database.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>selectId</code></td>
            

            <td class="type">
            
                
<span class="param-type">numeric</span>


            </td>

            
            <td class="description last">(OPTIONAL = undefined) If set then after the filter 
operation the record with this id will be selected (but not displayed).</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>display</code></td>
            

            <td class="type">
            
                
<span class="param-type">bool</span>


            </td>

            
            <td class="description last">(OPTIONAL = false) If true then the selected record will 
be displayed on the form.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="backend_services.js.html">backend_services.js</a>, <a href="backend_services.js.html#line374">line 374</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="getFilterHtml"><span class="type-signature"></span>getFilterHtml<span class="signature">(service)</span><span class="type-signature"> &rarr; {string}</span></h4>

    
<div class="description">
    Get a service row html code that is going to be displayed on the filter results 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>service</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            </td>

            
            <td class="description last">Contains the service record data.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="backend_services.js.html">backend_services.js</a>, <a href="backend_services.js.html#line413">line 413</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The html code that represents the record on the filter results list.
</div>


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


    </dd>
</dl>

    
    <h4 class="name" id="resetForm"><span class="type-signature"></span>resetForm<span class="signature">()</span><span class="type-signature"></span></h4>

    
<div class="description">
    Resets the service tab form back to its initial state.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="backend_services.js.html">backend_services.js</a>, <a href="backend_services.js.html#line333">line 333</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">(service)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Save service record to database.
</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>service</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            </td>

            
            <td class="description last">Contains the service record data. If an 'id' value is provided
then the update operation is going to be executed.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="backend_services.js.html">backend_services.js</a>, <a href="backend_services.js.html#line257">line 257</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="select"><span class="type-signature"></span>select<span class="signature">(id, display)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Select a specific record from the current filter results. If the service id does not exist 
in the list then no record will be selected.
</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>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">numeric</span>


            </td>

            
            <td class="description last">The record id to be selected from the filter results.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>display</code></td>
            

            <td class="type">
            
                
<span class="param-type">bool</span>


            </td>

            
            <td class="description last">(OPTIONAL = false) If true then the method will display the record
on the form.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="backend_services.js.html">backend_services.js</a>, <a href="backend_services.js.html#line432">line 432</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="validate"><span class="type-signature"></span>validate<span class="signature">(service)</span><span class="type-signature"> &rarr; {bool}</span></h4>

    
<div class="description">
    Validates a service record.
</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>service</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            </td>

            
            <td class="description last">Contains the service data.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="backend_services.js.html">backend_services.js</a>, <a href="backend_services.js.html#line307">line 307</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Returns the validation result.
</div>


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


    </dd>
</dl>

    
</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AdminsHelper.html">AdminsHelper</a></li><li><a href="CategoriesHelper.html">CategoriesHelper</a></li><li><a href="CustomersHelper.html">CustomersHelper</a></li><li><a href="ProvidersHelper.html">ProvidersHelper</a></li><li><a href="SecretariesHelper.html">SecretariesHelper</a></li><li><a href="ServicesHelper.html">ServicesHelper</a></li><li><a href="SystemSettings.html">SystemSettings</a></li><li><a href="UserSettings.html">UserSettings</a></li><li><a href="WorkingPlan.html">WorkingPlan</a></li></ul><h3>Namespaces</h3><ul><li><a href="Backend.html">Backend</a></li><li><a href="BackendCalendar.html">BackendCalendar</a></li><li><a href="BackendCustomers.html">BackendCustomers</a></li><li><a href="BackendServices.html">BackendServices</a></li><li><a href="BackendSettings.html">BackendSettings</a></li><li><a href="BackendUsers.html">BackendUsers</a></li><li><a href="FrontendBook.html">FrontendBook</a></li><li><a href="GeneralFunctions.html">GeneralFunctions</a></li></ul><h3>Global</h3><ul><li><a href="global.html#enableCancel">enableCancel</a></li><li><a href="global.html#enableSubmit">enableSubmit</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha13</a> on Wed Jan 21 2015 23:15:08 GMT+0100 (CET)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>