blob: 60defb393398ca0d612d1523eb7eab5762521f7e [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<link href="style.css" rel="stylesheet" type="text/css"/>
<title>Thrift module: allocation_manager_cpi</title></head><body>
<div class="container-fluid">
<h1>Thrift module: allocation_manager_cpi</h1>
<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead>
<tr>
<td>allocation_manager_cpi</td><td><a href="#Svc_AllocationRegistryService">AllocationRegistryService</a><br/>
<ul>
<li><a href="#Fn_AllocationRegistryService_createAllocationRequest">createAllocationRequest</a></li>
<li><a href="#Fn_AllocationRegistryService_deleteAllocationRequest">deleteAllocationRequest</a></li>
<li><a href="#Fn_AllocationRegistryService_getAllocationManagerAdminEmail">getAllocationManagerAdminEmail</a></li>
<li><a href="#Fn_AllocationRegistryService_getAllocationRequest">getAllocationRequest</a></li>
<li><a href="#Fn_AllocationRegistryService_getAllocationRequestStatus">getAllocationRequestStatus</a></li>
<li><a href="#Fn_AllocationRegistryService_getAllocationRequestUserEmail">getAllocationRequestUserEmail</a></li>
<li><a href="#Fn_AllocationRegistryService_getAllocationRequestUserName">getAllocationRequestUserName</a></li>
<li><a href="#Fn_AllocationRegistryService_isAllocationRequestExists">isAllocationRequestExists</a></li>
<li><a href="#Fn_AllocationRegistryService_updateAllocationRequest">updateAllocationRequest</a></li>
</ul>
</td>
<td></td>
<td></code></td>
</tr></table>
<hr/><h2 id="Services">Services</h2>
<h3 id="Svc_AllocationRegistryService">Service: AllocationRegistryService</h3>
<div class="definition"><h4 id="Fn_AllocationRegistryService_createAllocationRequest">Function: AllocationRegistryService.createAllocationRequest</h4>
<pre><code>string</code> createAllocationRequest(<code><a href="allocation_manager_models.html#Struct_UserAllocationDetail">allocation_manager_models.UserAllocationDetail</a></code> allocDetail)
</pre><p>API method to create new allocation requests</p>
<br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_isAllocationRequestExists">Function: AllocationRegistryService.isAllocationRequestExists</h4>
<pre><code>bool</code> isAllocationRequestExists(<code>string</code> projectId)
</pre><p>API method to check if the allocation request exists</p>
<br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_deleteAllocationRequest">Function: AllocationRegistryService.deleteAllocationRequest</h4>
<pre><code>bool</code> deleteAllocationRequest(<code>string</code> projectId)
</pre><p>API method to delete allocation request</p>
<br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_getAllocationRequest">Function: AllocationRegistryService.getAllocationRequest</h4>
<pre><code><a href="allocation_manager_models.html#Struct_UserAllocationDetail">allocation_manager_models.UserAllocationDetail</a></code> getAllocationRequest(<code>string</code> projectId)
</pre><p>API method to get an allocation Request</p>
<br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_updateAllocationRequest">Function: AllocationRegistryService.updateAllocationRequest</h4>
<pre><code>bool</code> updateAllocationRequest(<code><a href="allocation_manager_models.html#Struct_UserAllocationDetail">allocation_manager_models.UserAllocationDetail</a></code> allocDetail)
</pre><p>API method to update an allocation Request</p>
<br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_getAllocationRequestStatus">Function: AllocationRegistryService.getAllocationRequestStatus</h4>
<pre><code>string</code> getAllocationRequestStatus(<code>string</code> projectId)
</pre><p>API method to get an allocation Request status</p>
<br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_getAllocationRequestUserEmail">Function: AllocationRegistryService.getAllocationRequestUserEmail</h4>
<pre><code>string</code> getAllocationRequestUserEmail(<code>string</code> userName)
</pre><p>API method to get an allocation Request PI email</p>
<br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_getAllocationManagerAdminEmail">Function: AllocationRegistryService.getAllocationManagerAdminEmail</h4>
<pre><code>string</code> getAllocationManagerAdminEmail(<code>string</code> userType)
</pre><p>API method to get an allocation Request Admin email</p>
<br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_getAllocationRequestUserName">Function: AllocationRegistryService.getAllocationRequestUserName</h4>
<pre><code>string</code> getAllocationRequestUserName(<code>string</code> projectId)
</pre><p>API method to get an allocation Request PI</p>
<br/></div></div></body></html>